wavelabs_client_api 0.3.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad248de74514dbe4c337a35159b3c4a2ec5093de
+  data.tar.gz: db071cb2e5a64da44d2a3695d0871f8f72b1b8fe
+SHA512:
+  metadata.gz: afb8012f604966605637014020e22c23958c6907f65bf8aa8d64d391f646a1f38c59ac2c07e9baefe7f005bb28a24aaf554d3f5a565a3a0cc5ddc0de766cfbb2
+  data.tar.gz: 53aa1f7008c2cad041c44475c70337a30533a513e0aba47c8ba274b1e727ebb237fd24c9b3721267946edbeb661037beefa98b01449dc3eaffe4d23ea51057b0

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6
+
+addons:
+  code_climate:
+    repo_token: 1d83847d90af4ec2619c0adff9b60265cd770a7f7b6317026ff0cee3a59b630a

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wavelabs_client_api.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 sekhar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+
+# Current Version
+[![Gem Version](https://badge.fury.io/rb/wavelabs_client_api.svg)](https://badge.fury.io/rb/wavelabs_client_api)
+
+# Code Statistics 
+[![Build Status](https://travis-ci.org/nbostech/wavelabs-client-api.svg?branch=master)](https://travis-ci.org/nbostech/wavelabs-client-api)
+[![Code Climate](https://codeclimate.com/github/nbostech/wavelabs-client-api/badges/gpa.svg)](https://codeclimate.com/github/nbostech/wavelabs-client-api)
+[![Test Coverage](https://codeclimate.com/github/nbostech/wavelabs-client-api/badges/coverage.svg)](https://codeclimate.com/github/nbostech/wavelabs-client-api/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 Sign Up(Login with facebook, github ..etc)
+
+This library is used to send requests to Wavelabs Server API and get response. Following are the run time dependencies
+    
+    1. ruby-2.2.3
+    2. activemodel-4.2.4
+    3. httmultiparty-0.3.16 
+
+There is an example rails application in github https://github.com/nbostech/wavelabs-rails-client-api. You can clone and use that application. 
+
+Live example is available on heroku https://wavelabs-rails-client-api.herokuapp.com
+
+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.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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
+
+    $ 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 provide 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'] = 'my-client'
+    ENV['API_CLIENT_SECRET'] = 'my-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'/'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", "oauth.client.r")
+     $request = WavelabsClientApi::Client::Api::Core::UsersApi.new
+     $sign_up_params = { :username  =>  "username",
+                        :password  =>  "password123",
+                        :email     =>  "username@test.com",
+                        :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. If you want to use this gem in your rails application I have created a sample application here https://github.com/nbostech/wavelabs-rails-client-api
+   
+## 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](https://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](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec
+ 
+RSpec::Core::RakeTask.new do |task|
+  task.rspec_opts = ['--color', '--format', 'doc']
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wavelabs_client_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/templates/wavelabs_client_api_initializer.rb

@@ -0,0 +1,13 @@
+WavelabsClientApi.configure do |config|
+  # Set this options to what makes sense for you
+  # If you are using ENV variables setup the required ENV variables 
+  config.api_host_url = ENV['API_HOST_URL']
+  config.client_key = ENV['API_CLIENT_KEY']
+  config.client_secret = ENV['API_CLIENT_SECRET']
+
+  # If you are not using ENV variables comment out the follwing lines
+  # And provide your api server url, client key & client secret
+  # config.api_host_url = "API Server Url"
+  # config.client_key = "Client Key"
+  # config.client_secret = "Client Secret"
+end

data/lib/generators/wavelabs_client_api/install_generator.rb

@@ -0,0 +1,17 @@
+module WavelabsClientApi
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates wavelabs client api initializer for your application"
+
+      def copy_initializer
+        template "wavelabs_client_api_initializer.rb", "config/initializers/wavelabs_client_api.rb"
+
+        puts "Install complete! Please make sure to set following ENV variables!"
+        puts "ENV['API_HOST_URL'] = 'site url' "
+        puts "ENV['CLIENT_ID'] = 'XXXXXX'"
+        puts "ENV['CLIENT_SECRET'] = 'XXXXXXXXX' "
+      end
+    end
+  end
+end

data/lib/wavelabs_client_api.rb

@@ -0,0 +1,34 @@
+require "wavelabs_client_api/version"
+
+require "wavelabs_client_api/client/api/core/base_api"
+require "wavelabs_client_api/client/api/core/auth_api"
+require "wavelabs_client_api/client/api/core/users_api"
+require "wavelabs_client_api/client/api/core/media_api"
+require "wavelabs_client_api/client/api/core/social_api"
+
+
+require "wavelabs_client_api/client/api/data_models/base_api_model"
+require "wavelabs_client_api/client/api/data_models/login_api_model"
+require "wavelabs_client_api/client/api/data_models/media_api_model"
+require "wavelabs_client_api/client/api/data_models/member_api_model"
+require "wavelabs_client_api/client/api/data_models/message_api_model"
+require "wavelabs_client_api/client/api/data_models/social_accounts_api_model"
+require "wavelabs_client_api/client/api/data_models/token_api_model"
+require "wavelabs_client_api/client/api/data_models/token_details_api_model"
+
+module WavelabsClientApi
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :api_host_url, :client_key, :client_secret
+  end
+
+end

data/lib/wavelabs_client_api/client/api/core/auth_api.rb

@@ -0,0 +1,179 @@
+
+# This class is responsible for handling
+# Requests from Com::Nbos::Core::AuthController.
+# It will create the request based on Controller request params and 
+# send that request to Wavelabs API server and return the response back.
+# While sending respose back to receiver it will create the virtual models
+# from Com::Nbos::Api::DataModels
+class WavelabsClientApi::Client::Api::Core::AuthApi < WavelabsClientApi::Client::Api::Core::BaseApi
+  
+  # Api Server Authentication End Point URIs
+  AUTH_TOKEN_URI       = "/oauth/token"
+  TOKEN_VALIDATION_URI = "/api/oauth/v0/tokens"
+  LOGIN_URI            = "/api/identity/v0/auth/login"
+  LOGOUT_URI           = "/api/identity/v0/auth/logout"
+  CHANGE_PASSWORD_URI  = "/api/identity/v0/auth/changePassword"
+  FORGOT_PASSWORD_URI  = "/api/identity/v0/auth/forgotPassword"
+  RESET_PASSWORD_URI   = "/api/identity/v0/auth/resetPassword"
+
+
+ 
+ #Method to get Access Token
+ def get_auth_token(grant_type, scope, clientId = nil, clientSecret = nil)
+   url_path = base_api_url(AUTH_TOKEN_URI)
+   query_params = { :client_id =>  clientId || client_id,
+                    :client_secret => clientSecret || client_secret,
+                    :grant_type => grant_type,
+                    :scope => scope
+                  }
+   body = nil
+   begin                                  
+     api_response = send_request('post', url_path, body , query_params)
+     details = api_response.code == 200 ? api_response.parsed_response : nil               
+     token_model = create_token_model(details)
+     build_token_response(api_response, token_model)
+   rescue StandardError
+     token_model = create_token_model(nil)
+     token_model.message = "API Server is Down Please try After Some Time."
+     { status: 500, token: token_model}
+   end                 
+ end
+
+ # Method to validate both client & user token
+ def is_token_valid(tokeId, access_token)
+   url_path = base_api_url(TOKEN_VALIDATION_URI + "/#{tokeId}")
+   api_response = send_request_with_token('get', url_path, access_token)
+   details = api_response.code == 200 ? api_response.parsed_response : nil
+   token_model = create_token_details_model(details)
+   build_token_response(api_response, token_model)
+ end 
+
+ def build_token_response(api_response, data_model)
+   begin
+     if api_response.code == 400
+        data_model.add_errors(api_response.parsed_response)
+        { status: 400, token: data_model}
+     else
+        data_model.add_messages(api_response.parsed_response)
+        { status: api_response.code, token: data_model}  
+     end
+   rescue StandardError
+     data_model.message = "Internal Server Error Please Try After Some Time."
+     { status: 500, token: data_model}
+   end    
+ end 
+
+ # Api Call to Change Password request with access_token
+ def change_password(change_password_params, access_token)
+ 	 url_path = base_api_url(CHANGE_PASSWORD_URI)
+ 	 connection_options = { :password =>  change_password_params[:password],
+                          :newPassword => change_password_params[:newPassword]
+                        }
+   login_model = create_login_model(change_password_params)                     
+ 	 
+   api_response = send_request_with_token('post', url_path, access_token, connection_options.to_json)
+   
+   build_password_response(api_response, login_model) 
+ end
+
+
+ # Api Call to get Reset Password Instructions
+ def forgot_password(forgot_password_params, access_token)
+ 	 url_path = base_api_url(FORGOT_PASSWORD_URI)
+ 	 connection_options = { :email => forgot_password_params[:email] }
+ 	 api_response = send_request_with_token('post', url_path, access_token, connection_options.to_json)
+   login_model = create_login_model(forgot_password_params)
+   
+   build_password_response(api_response, login_model)
+ end
+
+ def build_password_response(api_response, data_model)
+  begin
+     if api_response.code == 400
+        data_model.add_errors(api_response.parsed_response)
+        { status: 400, login: data_model}
+     else
+        data_model.add_messages(api_response.parsed_response)
+        { status: api_response.code, login: data_model}  
+     end
+   rescue StandardError
+     data_model.message = "Internal Server Error Please Try After Some Time."
+     { status: 500, login: data_model}
+   end
+ end 
+
+
+ # Api Call To Login 
+ def login(login_params = nil, access_token = nil)
+  login_model = create_login_model(login_params)
+
+  if login_params.present? && check_login_params(login_params)
+ 	 url_path = base_api_url(LOGIN_URI)
+ 	 connection_options = { :clientId => client_id, 
+ 	 	                      :username => login_params[:username], 
+ 	 	                      :password => login_params[:password]
+ 	 	                    }
+
+   api_response = send_request_with_token('post', url_path, access_token, connection_options.to_json)
+
+   begin
+     if api_response.code == 200
+        member_model = create_member_model(api_response.parsed_response, false)
+        { status: 200, member: member_model}   
+     elsif api_response.code == 400
+     	  login_model.add_errors(api_response.parsed_response)
+     	  { status: 400, member: nil, login: login_model}
+     else
+        login_model.add_messages(api_response.parsed_response)
+        { status: api_response.code, login: login_model}  
+     end
+   rescue StandardError
+     login_model.message = "Internal Server Error Please Try After Some Time."
+     { status: 500, login: login_model}
+   end
+
+  else
+    login_model.message = "Invalid login parameters"
+    { status: 500, login: login_model}
+  end  
+
+ end
+
+
+ # Api Call To Logout with Access Token
+ def logout(access_token)
+ 	 url_path = base_api_url(LOGOUT_URI)
+ 	 api_response = send_request_with_token('get', url_path, access_token)
+   login_model = create_login_model(nil)
+   
+   begin
+     if api_response.code == 200
+       login_model.add_messages(api_response.parsed_response)
+       {status: 200, login: login_model}
+     else
+       login_model.add_messages(api_response.parsed_response)
+       {status: api_response.code, login: login_model}
+     end
+   rescue StandardError
+     login_model.message = "Internal Server Error Please Try After Some Time."
+     { status: 500, login: login_model}
+   end  
+ end
+
+ 
+ # Need to Implement this based on Server Side Logic
+ def reset_password
+ 	 url_path = base_api_url(RESET_PASSWORD_URI)
+ end
+
+
+ def check_login_params(login_params)
+
+   if login_params.length == 2 && [:username, :password] == login_params.keys || ["username", "password"] == login_params.keys
+     true
+   else
+     false
+   end 
+ end 
+
+end