warbler-ruby 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0ebbd99626d73ae5eb8e026fbd89b968079c274
+  data.tar.gz: c622ce6e5905364ecd3a7b7df0ed739f9d213878
+SHA512:
+  metadata.gz: be6a456f449e2dc75d04e3f936dc7f9f4b3d9cba8fc4a78256c923dd6e4bfe703918cd35790425ccefdd990d267dca33020b04b7e0388fb839586edeaa7c6960
+  data.tar.gz: fa7ecfcb16746ec5ed1836346a1bf8e13edc809785297ae2d681f15fd9b642d003756a609a9f5d914545c190c65ddbfddb39f7576f17abaae5d47efc5e351386

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 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.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,76 @@
+# Warbler Ruby Client Library
+
+The Warbler gem lets you integrate with Warbler to track activities, reward customers and let them redeem rewards without leaving your application.
+
+## Dependencies
+
+* unirest
+
+## Installaction
+
+```bash
+gem install warbler
+```
+
+Or add it to your gemfile
+
+```ruby
+gem 'warbler'
+```
+
+## Quick Start Example
+
+1. Sign up for a sandbox account on https://www.warblersandbox.com
+
+2. Get your `merchant_token` from the 'Authorization Tokens' area available under 'Settings'
+
+3. Define an initializer holding the following values
+
+  ```ruby
+  Warbler::Configuration.merchant_token = xxxxx # merchant_token from step 2
+  Warbler::Configuration.mode = 'sandbox' # or 'production'
+  Warbler::Configuration.device_identifier = 'webapp'
+  ```
+
+4. Define the methods you'll use accross the app
+
+  ```ruby
+  module Warblerable
+    def identify_warbler_user(user)
+      session[:device_token] = Warbler::UsersController.new.identify(user.email)['device_token']
+    end
+
+    def track_warbler_activity(activity_slug)
+      Warbler::ActivitiesController.new(session[:device_token]).track(activity_slug)
+    end
+
+    def list_warbler_rewards
+      Warbler::RewardsController.new(session[:device_token]).list
+    end
+
+    def show_warbler_reward(reward_id)
+      Warbler::RewardsController.new(session[:device_token]).show(reward_id)
+    end
+
+    def redeem_warbler_reward(reward_id)
+      Warbler::RewardsController.new(session[:device_token]).redeem(reward_id)
+    rescue Warbler::APIException => e
+      redirect_to :back, alert: JSON.parse(e.message).to_sentence
+    end
+  end
+  ```
+
+5. Use the methods defined in the previous step
+
+## Sample Project
+
+Check out our [Sample Ruby on Rails project](https://github.com/warblerdigital/warbler-ruby-sample).
+
+## Help
+
+If you have any questions feel free to email us at hello@warbler.com
+We are happy to help.
+
+## Licence
+
+See the LICENCE file.

data/lib/warbler-ruby.rb

@@ -0,0 +1,20 @@
+# This file was automatically generated by APIMATIC BETA v2.0 on 03/02/2016
+require 'openssl'
+require 'json'
+require 'unirest'
+
+# APIMATIC Helper Files
+require 'warbler/api_helper.rb'
+require 'warbler/api_exception.rb'
+require 'warbler/configuration.rb'
+
+# Controllers
+require 'warbler/controllers/application_controller.rb'
+require 'warbler/controllers/users_controller.rb'
+require 'warbler/controllers/activities_controller.rb'
+require 'warbler/controllers/rewards_controller.rb'
+
+# Models
+
+# Warbler Overrides
+require 'warbler/authorization.rb'

data/lib/warbler/api_exception.rb

@@ -0,0 +1,23 @@
+# This file was automatically generated by APIMATIC BETA v2.0 on 03/02/2016
+
+module Warbler
+  class APIException < StandardError
+
+    # value store
+    attr_reader :response_code
+
+	# value store
+    attr_reader :response_body
+
+    # The HTTP response code from the API request
+    # @param [String] the reason for raising an exception
+    # @param [Numeric] the HTTP response code from the API request
+	# @param [Object] the HTTP unprased response from the API request
+    def initialize(reason, response_code, response_body)
+        super(reason)
+        @response_code = response_code
+		@response_body = response_body
+    end
+
+  end
+end

data/lib/warbler/api_helper.rb

@@ -0,0 +1,82 @@
+# This file was automatically generated by APIMATIC BETA v2.0 on 03/02/2016
+
+module Warbler
+  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.is_a? String
+
+      # return if there are no parameters to replace
+      if parameters.nil? then
+        abort('no parameters to append')
+      end
+
+      # iterate and append parameters
+      parameters.map do |key, value|
+        replace_value = ''
+
+        if value.nil?
+            replace_value = ''
+        elsif value.is_a? Enumerable
+            replace_value = value.join("/")
+        else
+            replace_value = 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
+
+      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.is_a? String
+
+      # return if there are no parameters to replace
+      if parameters.nil? then
+        abort('no parameters to append')
+      end
+
+      #remove any nil values
+      parameters = parameters.reject {|key, value| value.nil?}
+
+      # does the query string already has parameters
+      has_params = query_builder.include? '?'
+      separator = if has_params then '&' else '?' end
+
+      # append query with separator and parameters
+      query_builder << separator << URI.unescape(URI.encode_www_form(parameters))
+    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.is_a? String
+
+      # ensure that the urls are absolute
+      matches = url.match(/^(https?:\/\/[^\/]+)/)
+      raise ArgumentError, 'Invalid Url format.' if matches.nil?
+
+      # get the http protocol match
+      protocol = matches[1]
+
+      # remove redundant forward slashes
+      query = url[protocol.length..-1].gsub(/\/\/+/, '/')
+
+      # return process url
+      return protocol + query;
+    end
+
+  end
+end

data/lib/warbler/authorization.rb

@@ -0,0 +1,58 @@
+require 'securerandom'
+require 'addressable/uri'
+
+module Warbler
+  class Authorization
+    def initialize(method, url, device_token = nil)
+      @method       = method.to_s.upcase
+      @url          = Addressable::URI.parse(url)
+      @device_token = device_token
+    end
+
+    def header
+      [ base_header, header_params ].compact.join(', ')
+    end
+
+    private
+
+    def base_header
+      "Token token=\"#{ Configuration.merchant_token }\""
+    end
+
+    def header_params
+      "nonce=\"#{ nonce }\", timestamp=\"#{ timestamp }\", auth=\"#{ signature }\"" if @device_token
+    end
+
+    def nonce
+      @nonce ||= SecureRandom.hex(8)
+    end
+
+    def timestamp
+      @timestamp ||= Time.now.to_i
+    end
+
+    def merchant_token
+      Configuration.merchant_token
+    end
+
+    def message
+      "#{ @method },#{ @url.host }:#{ port },nonce=#{ nonce },timestamp=#{ timestamp },#{ @url.path }"
+    end
+
+    def port
+      ('https' == @url.scheme) ? 443 : 80
+    end
+
+    def signature
+      Base64.strict_encode64(hmac)
+    end
+
+    def hmac
+      OpenSSL::HMAC.digest(digest, @device_token.encode('ASCII'), message.encode('ASCII'))
+    end
+
+    def digest
+      @digest ||= OpenSSL::Digest.new('sha1')
+    end
+  end
+end

data/lib/warbler/configuration.rb

@@ -0,0 +1,15 @@
+# This file was automatically generated by APIMATIC BETA v2.0 on 03/02/2016
+
+module Warbler
+  class Configuration
+    @mode = ''
+    @merchant_token = ''
+    @device_identifier = ''
+
+    class << self
+      attr_accessor :mode
+      attr_accessor :merchant_token
+      attr_accessor :device_identifier
+    end
+  end
+end

data/lib/warbler/controllers/activities_controller.rb

@@ -0,0 +1,26 @@
+# This file was automatically generated by APIMATIC BETA v2.0 on 03/02/2016
+
+module Warbler
+  class ActivitiesController < ApplicationController
+
+    # This endpoint lets you track the actions your users perform.
+    # @param [String] activity_type Required parameter: The type of activity the user is performing. Example: 'purchased-a-product'
+    # @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 activity_type, record_id: nil
+      # the base uri for api requests
+      query_builder = base_uri
+
+      # prepare query string for API call
+      query_builder << "/v3/activities"
+
+      # process optional query parameters
+      query_builder = APIHelper.append_url_with_query_parameters query_builder, {
+        "activity_type" => activity_type,
+        "record_id" => record_id,
+      }
+
+      perform_query('post', query_builder)
+    end
+  end
+end

data/lib/warbler/controllers/application_controller.rb

@@ -0,0 +1,36 @@
+module Warbler
+  class ApplicationController
+    def initialize(device_token = nil)
+      @device_token = device_token
+    end
+
+    private
+
+    def base_uri
+      Configuration.mode == 'production' ? 'https://api.warbler.com' : 'https://api.warblersandbox.com'
+    end
+
+    def headers(http_verb, query)
+      {
+        "User-Agent" => "APIMATIC 2.0",
+        "Accept" => "application/json",
+        "Content-Type" => "application/json",
+        "X-Device-Identifier" => Configuration.device_identifier,
+        "Authorization" => Authorization.new(http_verb.to_sym, APIHelper.clean_url(query), @device_token).header
+      }
+    end
+
+    def perform_query(http_verb, query)
+      # Invoke the API call request to fetch the response
+      response = Unirest.send(http_verb, query, headers: headers(http_verb, query))
+
+      # Handle errors using HTTP status codes
+      if !(response.code.between?(200,206)) # [200,206] = HTTP OK
+        raise APIException.new response.body['detail'], response.code, response.raw_body
+      end
+
+      # Return the response
+      response.body
+    end
+  end
+end

data/lib/warbler/controllers/rewards_controller.rb

@@ -0,0 +1,84 @@
+# This file was automatically generated by APIMATIC BETA v2.0 on 03/02/2016
+
+module Warbler
+  class RewardsController < ApplicationController
+
+    # List all the available rewards.
+    # @param [Numeric] category_id Optional parameter: The id of the category to filter rewards by
+    # @param [Numeric] limit Optional parameter: The number of rewards you want to be retrieved.
+    # @param [Numeric] offset Optional parameter: The number of rewards you want to skip before starting the retrieval.
+    # @return mixed response from the API call
+    def list category_id: nil, limit: 25, offset: 0
+      # the base uri for api requests
+      query_builder = base_uri
+
+      # prepare query string for API call
+      query_builder << "/v3/rewards"
+
+      # process optional query parameters
+      query_builder = APIHelper.append_url_with_query_parameters query_builder, {
+        "category_id" => category_id,
+        "limit" => if limit.nil? then 25 else limit end,
+        "offset" => if offset.nil? then 0 else offset end,
+      }
+
+      perform_query('get', query_builder)
+    end
+
+    # Bid on a reward auction.
+    # @param [String] amount Required parameter: Can be either 'max' (when max bidding) or the number of points the user wants to bid.
+    # @param [Numeric] id Required parameter: Id of the reward
+    # @return mixed response from the API call
+    def bid amount, id
+      # the base uri for api requests
+      query_builder = base_uri
+
+      # prepare query string for API call
+      query_builder << "/v3/rewards/#{ id }/bids"
+
+      # process optional query parameters
+      query_builder = APIHelper.append_url_with_template_parameters query_builder, {
+        "id" => id,
+        "amount" => amount
+      }
+
+      perform_query('post', query_builder)
+    end
+
+    # Show a reward's details.
+    # @param [Numeric] id Required parameter: Id of the reward
+    # @return mixed response from the API call
+    def show id
+      # the base uri for api requests
+      query_builder = base_uri
+
+      # prepare query string for API call
+      query_builder << "/v3/rewards/#{ id }"
+
+      # process optional query parameters
+      query_builder = APIHelper.append_url_with_template_parameters query_builder, {
+        "id" => id,
+      }
+
+      perform_query('get', query_builder)
+    end
+
+    # Redeem a reward.
+    # @param [Numeric] id Required parameter: Id of the reward
+    # @return mixed response from the API call
+    def redeem id
+      # the base uri for api requests
+      query_builder = base_uri
+
+      # prepare query string for API call
+      query_builder << "/v3/rewards/#{ id }/redemptions"
+
+      # process optional query parameters
+      query_builder = APIHelper.append_url_with_template_parameters query_builder, {
+        "id" => id,
+      }
+
+      perform_query('post', query_builder)
+    end
+  end
+end

data/lib/warbler/controllers/users_controller.rb

@@ -0,0 +1,28 @@
+# This file was automatically generated by APIMATIC BETA v2.0 on 03/02/2016
+
+module Warbler
+  class UsersController < ApplicationController
+
+    # 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.
+    # @param [String] email Required parameter: The user's email address
+    # @param [String] first_name Optional parameter: The user's first name
+    # @param [String] last_name Optional parameter: The user's last name
+    # @return mixed response from the API call
+    def identify email, first_name: nil, last_name: nil
+      # the base uri for api requests
+      query_builder = base_uri
+
+      # prepare query string for API call
+      query_builder << "/v3/users"
+
+      # process optional query parameters
+      query_builder = APIHelper.append_url_with_query_parameters query_builder, {
+        "email" => CGI::escape(email),
+        "first_name" => first_name,
+        "last_name" => last_name,
+      }
+
+      perform_query('post', query_builder)
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: warbler-ruby
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- APIMATIC
+- Zeeshan Ejaz Bhatti
+- Vero Rebagliatte
+- Gustavo Beathyate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: The warbler gem lets you integrate with Warbler to track activities,
+  reward customers and let them redeem rewards without leaving your application.
+email: hello@warbler.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/warbler-ruby.rb
+- lib/warbler/api_exception.rb
+- lib/warbler/api_helper.rb
+- lib/warbler/authorization.rb
+- lib/warbler/configuration.rb
+- lib/warbler/controllers/activities_controller.rb
+- lib/warbler/controllers/application_controller.rb
+- lib/warbler/controllers/rewards_controller.rb
+- lib/warbler/controllers/users_controller.rb
+homepage: https://www.warbler.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: The warbler gem lets you integrate with Warbler
+test_files: []