Skip to content

Latest commit

 

History

History
145 lines (88 loc) · 5.89 KB

README.md

File metadata and controls

145 lines (88 loc) · 5.89 KB
Raw

Current Version

Gem Version

Code Statistics

Build Status Code Climate Test Coverage

WavelabsClientApi

Welcome to wavelabs client api gem. It is flexible wrapper to communicate with Wavelabs Server API. Using this library you can easily interact with Wavelabs Server API. This release supports User Registration Module:

  1. Sign Up
  2. Sign In
  3. Forgot Password
  4. Change Password
  5. Edit Profile
  6. Upload Profile Picture
  7. Social Networks(Login with facebook, github ..etc)

This library is used to send requests to Wavelabs Server API and get response.

There is an example rails application in github. You can clone and use that application.

Live example is available on heroku

This gem contains two main modules under /lib directory

  1. WaveLabsClientApi::Client::Api::Core which have the classes to handle server communication.

  2. WaveLabsClientApi::Client::Api::DataModels which have the ActiveModel classes to create model objects.

Ruby & Rails versions

  • Ruby 2.2.3

  • Rails 4.2.4

You can install required versions of ruby, rails & gemsets using rvm(ruby version manager)

Installation

Add this line to your Rails application's Gemfile:

gem 'wavelabs_client_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install wavelabs_client_api

After successful instalation run the following command to generate wavelabs_client_api.rb configuration file under config/initializers directory of your rails application.

$ rails g wavelabs_client_api:install

In above configuration file setup the following core variables to work with API Server.

  1. If you want to use ENV variables jump to Usage section. Nothing to change in configuration file.

  2. If you are not using ENV variables, add configuration option values in wavelabs_client_api.rb file in initializers directory as follows:
    ```

WavelabsClientApi.configure do |config|
  config.api_host_url = "your API server url"
  config.client_key = "your client key"
  config.client_secret = "your client secret"
end
```

Usage

After installing the gem & configuration file you can create your own controllers & use the Core module class methods to comminicate Wavelabs Server API. To use this wrapper first you need to add following environment(ENV) variables in your rails aplication:


  ### WaveLabs Server Details 
  ENV['API_HOST_URL']  = 'http://api.qa1.wavelabs.in/'
  ENV['API_CLIENT_KEY'] = 'sample-app-client'
  ENV['API_CLIENT_SECRET'] = 'sample-app-secret' 
  
  ### Social Login Details
  ENV['FACEBOOK_KEY'] = 'FACEBOOK APP KEY'
  ENV['FACEBOOK_SECRET'] = 'FACEBOOK APP SECRET'

  ENV['GOOGLE_KEY'] = 'GOOGLE APP KEY'
  ENV['GOOGLE_SECRET'] = 'GOOGLE APP SECRET'

  ENV['GITHUB_KEY'] = 'GITHUB APP KEY'
  ENV['GITHUB_SECRET'] = 'GITHUB APP SECRET'

  ENV['LINKEDIN_KEY'] = 'LINKEDIN APP KEY'
  ENV['LINKEDIN_SECRET'] = "LINKEDIN APP SECRET"

  ENV['INSTAGRAM_KEY'] = 'INSTAGRAM APP KEY'
  ENV['INSTAGRAM_SECRET'] = 'INSTAGRAM APP KEY'

There are many ways to setup the ENV variables in rails. You can directly add them into your environment specific rb file, for example 'config/enviroments/development.rb' or you can use 'dot-env'or 'figaro' gems.

Note: You can use above Wavelabs Server details. It's public. And you need to create your own apps for social logins & modify social login details.

Now you are ready to communicate with the Server. Following is an example to send a sign_up request from ruby console:

 $auth_api = WavelabsClientApi::Client::Api::Core::AuthApi.new
 $get_token_req = auth_api.get_auth_token("client_credentials")
 $request = WavelabsClientApi::Client::Api::Core::UsersApi.new
 $sign_up_params = { :username  =>  "username",
                    :password  =>  "password123",
                    :email     =>  "[email protected]",
                    :firstName =>  "first name",
                    :lastName  =>  "last name"
                  }
 $response = request.sign_up(sign_up_params, get_token_req[:token].value)

You will get the approprivate response from server. we have created a sample applicationhere.

Note

continuous changes will be made based on Wavelabs Server API architecture.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake false to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wavelabs_client_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.