Creating a new project
The first thing you'll need to do is to create a new rails application using the connector template:
The framework work with either ruby-2.3.x or jruby-9.1.10.0. It is always cleaner to use a new gemset (rvm use jruby-9.1.10.0@connector-test --create). You'll may want to create a .ruby-version file in your project folder so that it takes this gemset by default.
For example:
# With JRuby rvm use jruby-9.1.10.0@connector-test --create # With MRI rvm use ruby-2.3.1@connector-test --create # Install rails gem install rails -v '4.2.9'
Then create your connector project:
rails new <project_name> -m https://raw.githubusercontent.com/Maestrano/maestrano-connector-rails/master/template/maestrano_connector_template.rb
This will generate a new pre-populated project with a custom Gemfile, some controllers and views, a bunch of models for your to complete as well as some example files.
Having troubles with the template? See the details of what it does so that you can understand what's wrong and fix it easily:
Configuring the integration with Maestrano
The configuration of your application is driven by the Maestrano Developer Platform, you first need to register and create your application: https://dev-platform.maestrano.com After registering your application, create a new Environment, this will generate a set of API keys to be used to automatically configure your application.
You will then specify your application API keys in the file config/application.yml
# This keys are used to encrypt OAuth tokens (or API Keys) and should be set to 256-bit Keys encryption_key1: 'E5CD3EDD6E577441CAB9142A1C36A' encryption_key2: '9B1EF27DF57296E8E1A9143EEB783' SIDEKIQ_USERNAME: admin SIDEKIQ_PASSWORD: password REDIS_URL: redis://localhost:6379/0/connector-test MNO_DEVPL_HOST: https://developer.maestrano.com MNO_DEVPL_API_PATH: /api/config/v1/marketplaces MNO_DEVPL_ENV_NAME: connector-test MNO_DEVPL_ENV_KEY: [API KEY FROM DEVELOPER PLATFORM] MNO_DEVPL_ENV_SECRET:[API SECRET FROM DEVELOPER PLATFORM]
Local development
To test against a local development environment, create an Environment named Local in the Developer Platform and use your local application URL as the Application Host: http://localhost:3001
Live testing
To deploy on a public environment. we advise you to deploy the application on Heroku, or on Nex! and register a new Environment using its public endpoint.
To create the application on Nex!, you can refer to these articles:
The application will then be accessible in the MarketPlace from the sandbox environment, which you can access through the Developer Platform.