reward_sciences 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d3287bcbfff41333a60c6808e7453211285da59
+  data.tar.gz: f4bea6053d3d024b0bfd3b7b4d189ec50abfbd37
+SHA512:
+  metadata.gz: dd0c396879afd04439c44c165d59126fb6a18ab6ad5685b75f9fc4792435155210579718b25de65549dcc73528c4f569cbd5202493cfbea019c24b8df8abb076
+  data.tar.gz: 9901514c1a87a92db4bc57a0609681b4b67644ddfa14ac5df04e0daad1a292b1ed028d0c93d744041de46e753ff773b03b46b86cb822787744b8f9487322d570

data/LICENSE

@@ -0,0 +1,24 @@
+License:
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2016 APIMATIC Limited
+
+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,380 @@
+# Getting Started
+## How to Build
+
+This client library is a Ruby gem which can be compiled and used in your Ruby and Ruby on Rails project. This library requires a few gems from the RubyGems repository.
+
+1. Open the command line interface or the terminal and navigate to the folder containing the source code.
+2. Run ``` gem build reward_sciences.gemspec ``` to build the gem.
+3. Once built, the gem can be installed on the current work environment using ``` gem install reward_sciences-1.0.gem ```
+
+![Building Gem](http://apidocs.io/illustration/ruby?step=buildSDK&workspaceFolder=Reward Sciences-Ruby&workspaceName=RewardSciences&projectName=reward_sciences&gemName=reward_sciences&gemVer=1.0)
+
+## How to Use
+
+The following section explains how to use the RewardSciences Ruby Gem in a new Rails project using RubyMine™. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
+    
+#### 1. Starting a new project
+Close any existing projects in RubyMine™ by selecting ``` File -> Close Project ```. Next, click on ``` Create New Project ``` to create a new project from scratch.
+
+![Create a new project in RubyMine](http://apidocs.io/illustration/ruby?step=createNewProject0&workspaceFolder=Reward Sciences-Ruby&workspaceName=RewardSciences&projectName=reward_sciences&gemName=reward_sciences&gemVer=1.0)
+
+Next, provide ``` TestApp ``` as the project name, choose ``` Rails Application ``` as the project type, and click ``` OK ```.
+
+![Create a new Rails Application in RubyMine - step 1](http://apidocs.io/illustration/ruby?step=createNewProject1&workspaceFolder=Reward Sciences-Ruby&workspaceName=RewardSciences&projectName=reward_sciences&gemName=reward_sciences&gemVer=1.0)
+
+In the next dialog make sure that correct *Ruby SDK* is being used (minimum 2.0.0) and click ``` OK ```.
+
+![Create a new Rails Application in RubyMine - step 2](http://apidocs.io/illustration/ruby?step=createNewProject2&workspaceFolder=Reward Sciences-Ruby&workspaceName=RewardSciences&projectName=reward_sciences&gemName=reward_sciences&gemVer=1.0)
+
+This will create a new Rails Application project with an existing set of files and folder.
+
+#### 2. Add reference of the gem
+In order to use the RewardSciences gem in the new project we must add a gem reference. Locate the ``` Gemfile	``` in the *Project Explorer* window under the ``` TestApp ``` project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: ``` gem 'reward_sciences', '~> 1.0' ```
+
+![Add references of the Gemfile](http://apidocs.io/illustration/ruby?step=addReference&workspaceFolder=Reward Sciences-Ruby&workspaceName=RewardSciences&projectName=reward_sciences&gemName=reward_sciences&gemVer=1.0)
+
+
+#### 3. Adding a new Rails Controller
+Once the ``` TestApp ``` project is created, a folder named ``` controllers ``` will be visible in the *Project Explorer* under the following path: ``` TestApp > app > controllers ```. Right click on this folder and select ``` New -> Run Rails Generator... ```.
+
+![Run Rails Generator on Controllers Folder](http://apidocs.io/illustration/ruby?step=addCode0&workspaceFolder=Reward Sciences-Ruby&workspaceName=RewardSciences&projectName=reward_sciences&gemName=reward_sciences&gemVer=1.0)
+
+Selecting the said option will popup a small window where the generator names are displayed. Here, select the ``` controller ``` template.
+
+![Create a new Controller](http://apidocs.io/illustration/ruby?step=addCode1&workspaceFolder=Reward Sciences-Ruby&workspaceName=RewardSciences&projectName=reward_sciences&gemName=reward_sciences&gemVer=1.0)
+
+Next, a popup window will ask you for a Controller name and included Actions. For controller name provide ``` Hello ``` and include an action named ``` Index ``` and click ``` OK ```.
+
+![Add a new Controller](http://apidocs.io/illustration/ruby?step=addCode2&workspaceFolder=Reward Sciences-Ruby&workspaceName=RewardSciences&projectName=reward_sciences&gemName=reward_sciences&gemVer=1.0)
+
+A new controller class anmed ``` HelloController ``` will be created in a file named ``` hello_controller.rb ``` containing a method named ``` Index ```. In this method, add code for initialization and a sample for its usage.
+
+![Initialize the library](http://apidocs.io/illustration/ruby?step=addCode3&workspaceFolder=Reward Sciences-Ruby&workspaceName=RewardSciences&projectName=reward_sciences&gemName=reward_sciences&gemVer=1.0)
+
+## How to Test
+
+You can test the generated SDK and the server with automatically generated test
+cases as follows:
+
+  1. From terminal/cmd navigate to the root directory of the SDK.
+  2. Invoke: `bundle exec rake`
+
+## Initialization
+
+#### Authentication and Initialization
+In order to setup authentication and initialization of the API client, you need the following information.
+
+| Parameter | Description |
+|-----------|-------------|
+| o_auth_access_token | The OAuth 2.0 access token to be set before API calls |
+
+
+
+API client can be initialized as following.
+
+```ruby
+# Configuration parameters and credentials
+o_auth_access_token = "o_auth_access_token"; # The OAuth 2.0 access token to be set before API calls
+
+client = RewardSciences::RewardSciencesClient.new(o_auth_access_token)
+```
+
+The added initlization code can be debugged by putting a breakpoint in the ``` Index ``` method and running the project in debug mode by selecting ``` Run -> Debug 'Development: TestApp' ```.
+
+![Debug the TestApp](http://apidocs.io/illustration/ruby?step=addCode4&workspaceFolder=Reward Sciences-Ruby&workspaceName=RewardSciences&projectName=reward_sciences&gemName=reward_sciences&gemVer=1.0&initLine=client%20%3D%20RewardSciencesClient.new%28%27o_auth_access_token%27%29)
+
+# Class Reference
+## <a name="list_of_controllers"></a>List of Controllers
+
+* [Rewards](#rewards)
+* [RewardCategories](#reward_categories)
+* [Users](#users)
+* [Activities](#activities)
+
+## <a name="rewards"></a>![Class: ](http://apidocs.io/img/class.png ".Rewards") Rewards
+
+#### Get singleton instance
+The singleton instance of the ``` Rewards ``` class can be accessed from the API Client.
+```ruby
+rewards = client.rewards
+```
+
+### <a name="bid"></a>![Method: ](http://apidocs.io/img/method.png ".Rewards.bid") bid
+
+> Bid on a reward auction.
+
+```ruby
+def bid(user_id, 
+            reward_id, 
+            amount); end
+```
+
+#### Parameters: 
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| user_id |  ``` Required ```  | The ID of the user who is bidding on the reward auction. |
+| reward_id |  ``` Required ```  | The ID of the reward auction to be bid on. |
+| amount |  ``` Required ```  | Can be either 'max' (when max bidding) or the number of points the user wants to bid. |
+
+
+
+#### Example Usage:
+```ruby
+user_id = 225
+reward_id = 225
+amount = 'amount'
+
+result = rewards.bid(user_id, reward_id, amount)
+
+```
+
+
+
+
+### <a name="list"></a>![Method: ](http://apidocs.io/img/method.png ".Rewards.list") list
+
+> List all the available rewards.
+
+```ruby
+def list(category_id = nil, 
+             limit = 25, 
+             offset = 0); end
+```
+
+#### Parameters: 
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| category_id |  ``` Optional ```  | The id of the category to filter rewards by |
+| limit |  ``` Optional ```  ``` DefaultValue ```  | The number of rewards you want to be retrieved. |
+| offset |  ``` Optional ```  ``` DefaultValue ```  | The number of rewards you want to skip before starting the retrieval. |
+
+
+
+#### Example Usage:
+```ruby
+category_id = 225
+limit = 25
+offset = 0
+
+result = rewards.list(category_id, limit, offset)
+
+```
+
+
+
+
+### <a name="redeem"></a>![Method: ](http://apidocs.io/img/method.png ".Rewards.redeem") redeem
+
+> Redeem a reward.
+
+```ruby
+def redeem(user_id, 
+               reward_id); end
+```
+
+#### Parameters: 
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| user_id |  ``` Required ```  | The ID of the user who is redeeming the reward. |
+| reward_id |  ``` Required ```  | The ID of the reward to be redeemed. |
+
+
+
+#### Example Usage:
+```ruby
+user_id = 225
+reward_id = 225
+
+result = rewards.redeem(user_id, reward_id)
+
+```
+
+
+
+
+### <a name="show"></a>![Method: ](http://apidocs.io/img/method.png ".Rewards.show") show
+
+> Show a reward's details.
+
+```ruby
+def show(reward_id); end
+```
+
+#### Parameters: 
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| reward_id |  ``` Required ```  | The ID of the reward to be retrieved. |
+
+
+
+#### Example Usage:
+```ruby
+reward_id = 225
+
+result = rewards.show(reward_id)
+
+```
+
+
+
+
+[Back to List of Controllers](#list_of_controllers)
+## <a name="reward_categories"></a>![Class: ](http://apidocs.io/img/class.png ".RewardCategories") RewardCategories
+
+#### Get singleton instance
+The singleton instance of the ``` RewardCategories ``` class can be accessed from the API Client.
+```ruby
+rewardCategories = client.reward_categories
+```
+
+### <a name="list"></a>![Method: ](http://apidocs.io/img/method.png ".RewardCategories.list") list
+
+> List all the available reward categories.
+
+```ruby
+def list(limit = 25, 
+             offset = 0); end
+```
+
+#### Parameters: 
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| limit |  ``` Optional ```  ``` DefaultValue ```  | The number of reward categories you want to be retrieved. |
+| offset |  ``` Optional ```  ``` DefaultValue ```  | The number of reward categories you want to skip before starting the retrieval. |
+
+
+
+#### Example Usage:
+```ruby
+limit = 25
+offset = 0
+
+result = rewardCategories.list(limit, offset)
+
+```
+
+
+
+
+[Back to List of Controllers](#list_of_controllers)
+## <a name="users"></a>![Class: ](http://apidocs.io/img/class.png ".Users") Users
+
+#### Get singleton instance
+The singleton instance of the ``` Users ``` class can be accessed from the API Client.
+```ruby
+users = client.users
+```
+
+### <a name="show"></a>![Method: ](http://apidocs.io/img/method.png ".Users.show") show
+
+> This endpoint lets retrieve a user's details.
+
+```ruby
+def show(user_id); end
+```
+
+#### Parameters: 
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| user_id |  ``` Required ```  | The ID of the user to be retrieved. |
+
+
+
+#### Example Usage:
+```ruby
+user_id = 225
+
+result = users.show(user_id)
+
+```
+
+
+
+
+### <a name="identify"></a>![Method: ](http://apidocs.io/img/method.png ".Users.identify") identify
+
+> This endpoint lets you tie a user with his/her activities. You’ll want to identify a user with any relevant information as soon as they log-in or sign-up.
+
+```ruby
+def identify(email, 
+                 first_name = nil, 
+                 last_name = nil); end
+```
+
+#### Parameters: 
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| email |  ``` Required ```  | The user's email address |
+| first_name |  ``` Optional ```  | The user's first name |
+| last_name |  ``` Optional ```  | The user's last name |
+
+
+
+#### Example Usage:
+```ruby
+email = 'email'
+first_name = 'first_name'
+last_name = 'last_name'
+
+result = users.identify(email, first_name, last_name)
+
+```
+
+
+
+
+[Back to List of Controllers](#list_of_controllers)
+## <a name="activities"></a>![Class: ](http://apidocs.io/img/class.png ".Activities") Activities
+
+#### Get singleton instance
+The singleton instance of the ``` Activities ``` class can be accessed from the API Client.
+```ruby
+activities = client.activities
+```
+
+### <a name="track"></a>![Method: ](http://apidocs.io/img/method.png ".Activities.track") track
+
+> This endpoint lets you track the activities your users perform.
+
+```ruby
+def track(user_id, 
+              activity_type, 
+              price = nil, 
+              record_id = nil); end
+```
+
+#### Parameters: 
+
+| Parameter | Tags | Description |
+|-----------|------|-------------|
+| user_id |  ``` Required ```  | The ID of the user who is performing the activity. |
+| activity_type |  ``` Required ```  | The type of activity the user is performing. Example: 'purchased-a-product' |
+| price |  ``` Optional ```  | The price related to the activity, if any. Expressed in USD |
+| record_id |  ``` Optional ```  | The ID for the record associated with the activity in your database. |
+
+
+
+#### Example Usage:
+```ruby
+user_id = 225
+activity_type = 'activity_type'
+price = 225
+record_id = 'record_id'
+
+result = activities.track(user_id, activity_type, price, record_id)
+
+```
+
+
+
+
+[Back to List of Controllers](#list_of_controllers)
+
+

data/lib/reward_sciences/api_helper.rb

@@ -0,0 +1,151 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class APIHelper
+    # Replaces template parameters in the given url
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to replace in the url
+    def self.append_url_with_template_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      if parameters.nil?
+        query_builder
+      else
+        # iterate and append parameters
+        parameters.each do |key, value|
+          replace_value = ''
+
+          if value.nil?
+            replace_value = ''
+          elsif value.instance_of? Array
+            value.map!{|element| CGI.escape(element.to_s)}
+            replace_value = value.join('/')
+          else
+            replace_value = CGI.escape(value.to_s)
+          end
+
+          # find the template parameter and replace it with its value
+          query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+        end
+      end
+      return query_builder
+    end
+
+    # Appends the given set of parameters to the given query string
+    # @param [String] The query string builder to replace the template parameters
+    # @param [Array] The parameters to append
+    def self.append_url_with_query_parameters(query_builder, parameters)
+      # perform parameter validation
+      raise ArgumentError, 'Given value for parameter \"query_builder\" is invalid.' unless query_builder.instance_of? String
+
+      # return if there are no parameters to replace
+      if parameters.nil?
+        return query_builder
+      else
+        # remove any nil values
+        parameters = parameters.reject { |_key, value| value.nil? }
+
+        # does the query string already has parameters
+        has_params = query_builder.include? '?'
+        separator = has_params ? '&' : '?'
+
+        # append query with separator and parameters and return
+        return query_builder << separator << URI.encode_www_form(parameters)
+      end
+    end
+
+    # Validates and processes the given Url
+    # @param [String] The given Url to process
+    # @return [String] Pre-processed Url as string
+    def self.clean_url(url)
+      # perform parameter validation
+      raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
+
+      # ensure that the urls are absolute
+      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # get the http protocol match
+      protocol = matches[1]
+      
+      # check if parameters exist
+      index = url.index('?')
+
+      # remove redundant forward slashes
+      query = url[protocol.length...(index != nil ? index : url.length)]
+      query.gsub!(%r{\/\/+}, '/')
+
+      # get the parameters
+      parameters = index != nil ? url[url.index('?')...url.length] : ""
+
+      # return processed url
+      return protocol + query  + parameters
+    end	
+
+    # Parses JSON string.
+    # @param [String] A JSON string.
+    def self.json_deserialize(json)
+      begin
+        return JSON.parse(json)
+      rescue
+        raise TypeError, "Server responded with invalid JSON."
+      end
+    end
+
+    # Form encodes a hash of parameters.
+    # @param [Hash] The hash of parameters to encode.
+    # @return [Hash] A hash with the same parameters form encoded.
+    def self.form_encode_parameters(form_parameters)
+      encoded = Hash.new
+      form_parameters.each do |key, value|
+        encoded.merge!(APIHelper.form_encode value, key)
+      end 
+      return encoded
+    end
+
+    # Form encodes an object.
+    # @param [Dynamic] An object to form encode.
+    # @param [String] The name of the object.
+    # @return [Hash] A form encoded representation of the object in the form of a hash.
+    def self.form_encode(obj, instance_name)
+      retval = Hash.new
+
+      # If this is a structure, resolve it's field names.
+      if obj.kind_of? BaseModel
+        obj = obj.to_hash
+      end
+      
+      # Create a form encoded hash for this object.
+      if obj == nil
+        nil         
+      elsif obj.instance_of? Array
+        obj.each_with_index do |value, index|
+          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + index.to_s + "]"))
+        end
+      elsif obj.instance_of? Hash
+        obj.each do |key, value|
+          retval.merge!(APIHelper.form_encode(value, instance_name + "[" + key + "]"))
+        end
+      else
+        retval[instance_name] = obj
+      end
+      return retval
+    end
+  end
+end
+
+# extend types to support to_bool
+module ToBoolean
+  def to_bool
+    return true if self == true || self.to_s.strip =~ /^(true|yes|y|1)$/i
+    return false
+  end
+end
+
+class NilClass; include ToBoolean; end
+class TrueClass; include ToBoolean; end
+class FalseClass; include ToBoolean; end
+class Numeric; include ToBoolean; end
+class String; include ToBoolean; end

data/lib/reward_sciences/configuration.rb

@@ -0,0 +1,10 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class Configuration
+    class << self
+      attr_accessor :base_uri
+      attr_accessor :o_auth_access_token
+    end
+  end
+end

data/lib/reward_sciences/controllers/activities.rb

@@ -0,0 +1,75 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class Activities < BaseController
+    @@instance = Activities.new
+    # Singleton instance of the controller class
+    def self.instance
+      @@instance
+    end
+
+    # This endpoint lets you track the activities your users perform.
+    # @param [Integer] user_id Required parameter: The ID of the user who is performing the activity.
+    # @param [String] activity_type Required parameter: The type of activity the user is performing. Example: 'purchased-a-product'
+    # @param [Integer] price Optional parameter: The price related to the activity, if any. Expressed in USD
+    # @param [String] record_id Optional parameter: The ID for the record associated with the activity in your database.
+    # @return Mixed response from the API call
+    def track(user_id, 
+              activity_type, 
+              price = nil, 
+              record_id = nil)
+
+      # Validate required parameters
+      if user_id == nil
+        raise ArgumentError.new "Required parameter 'user_id' cannot be nil."
+      elsif activity_type == nil
+        raise ArgumentError.new "Required parameter 'activity_type' cannot be nil."
+      end
+
+      # the base uri for api requests
+      _query_builder = Configuration.base_uri.dup
+
+      # prepare query string for API call
+      _query_builder << '/activities'
+
+      # process optional query parameters
+      _query_builder = APIHelper.append_url_with_query_parameters _query_builder, {
+        'user_id' => user_id,
+        'activity_type' => activity_type,
+        'price' => price,
+        'record_id' => record_id
+      }
+
+      # validate and preprocess url
+      _query_url = APIHelper.clean_url _query_builder
+
+      # prepare headers
+      _headers = {
+        'user-agent' => 'APIMATIC 2.0',
+        'Authorization' => 'Bearer %s' % (Configuration.o_auth_access_token)
+      }
+
+      # Create the HttpRequest object for the call
+      _request = @http_client.post _query_url, headers: _headers
+      
+      # Call the on_before_request callback
+      @http_call_back.on_before_request(_request) if @http_call_back
+
+      # Invoke the API call and get the response
+      _response = @http_client.execute_as_string(_request)
+
+      # Wrap the request and response in an HttpContext object
+      _context = HttpContext.new(_request, _response)
+
+      # Call the on_after_response callback
+      @http_call_back.on_after_response(_context) if @http_call_back
+
+      # Global error handling using HTTP status codes.
+      validate_response(_context)
+
+      # Return appropriate response type
+      decoded = APIHelper.json_deserialize(_response.raw_body) if not (_response.raw_body.nil? or _response.raw_body.to_s.strip.empty?)
+      return decoded
+    end
+  end
+end

data/lib/reward_sciences/controllers/base_controller.rb

@@ -0,0 +1,32 @@
+# This file was automatically generated by APIMATIC v2.0 ( https://apimatic.io ).
+
+module RewardSciences
+  class BaseController
+    attr_accessor :http_client, :http_call_back
+
+    @@http_client = UnirestClient.new
+
+    def initialize(http_client: nil, http_call_back: nil)
+      @http_client = http_client ||= @@http_client
+      @http_call_back = http_call_back
+    end
+
+    def validate_response(context)			
+      if context.response.status_code == 400
+        raise APIException.new "400 - Bad Request", context
+      elsif context.response.status_code == 401
+        raise APIException.new "401 - Unauthorized", context
+      elsif context.response.status_code == 403
+        raise APIException.new "403 - Forbidden", context
+      elsif context.response.status_code == 404
+        raise APIException.new "404 - Not Found", context
+      elsif context.response.status_code == 415
+        raise APIException.new "415 - Unsupported Media Type", context
+      elsif context.response.status_code == 500
+        raise APIException.new "500 - Server Error", context
+      elsif !context.response.status_code.between?(200, 208) #[200,208] = HTTP OK
+        raise APIException.new 'HTTP Response Not OK', context
+      end
+    end
+  end
+end