usabilla_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88b288cbe2a7e43ed1477c763db86aceee16180c
-  data.tar.gz: 76b7f129876ad1399addd376afa6e0b8665b29e6
+  metadata.gz: dd858590143870feb277865af77a5df6fb214e0e
+  data.tar.gz: f568882361755a2f91b70c314b46f87a3688fb21
 SHA512:
-  metadata.gz: 06af446296d47cea9bf84cc2edf7ed716cd97aca470702b4bf48cc0730016a11321c13659d35eaf270ae7af283f318bb8df1ca35473dbfea82fb3cdd0a6b6047
-  data.tar.gz: 74173951d8452543d72d890393de2100eccad99bf486150fc1f6bd5fbd573c852443da52b0722ce93c42cc23686ae63a520b95527d36dfda0e10701a59bbc27a
+  metadata.gz: a1854cec8dd3dbab241540ea6c70f1b58cea8967dabc2d0f74fc8c060e1302ff29bf47813fdbdce23fcf2ecf4d73bc2caa12ff9a22a3bb248d06916c1d105048
+  data.tar.gz: 4abad0eca23e5aa09635001b31b80771a3bcaee741afb6ae719266e43605bab0f0b249f8cae85e957905fa089d7e85cb04de8af1440ca3d6816aebd31affdd00

data/README.md

@@ -0,0 +1,90 @@
+#Installation
+
+You can add it to your Gemfile with:
+```
+gem 'usabilla_api'
+```
+Run the bundle command to install it.
+
+#Configuration
+
+######Add these lines to the appropriate config/environments file
+Access & Secret Key are required
+```
+UsabillaApi.configuration.access_key = 'YOUR-ACCESS-KEY'
+UsabillaApi.configuration.secret_key = 'YOUR-SECRET-KEY'
+```
+Change 'YOUR-ACCESS-KEY' & 'YOUR-SECRET-KEY' to appropriate values.
+
+Get your access and secret key here: [Usabilla Member API](https://usabilla.com/member/api)
+
+You can either return an Object (default) or a the original JSON string.
+```
+UsabillaApi.configuration.json_response = true
+```
+Full Usabilla API documentation: [Usabilla API](https://usabilla.com/api)
+
+#Usage
+
+Simply add one of the following;
+(params = url query paramaters)
+
+To get the **buttons** api response
+```
+UsabillaApi.button(params)
+```
+To get the **buttons feedback** items api response
+```
+UsabillaApi.feedback_items(params)
+```
+To get the **campaign** api response
+```
+UsabillaApi.campaign(params)
+```
+To get the **campaign results** api response
+```
+UsabillaApi.campaign_results(params)
+```
+
+######Example
+```
+# Controller /button_controller.rb
+def show
+  @buttons = UsabillaApi.button(params)
+end
+```
+```
+# View /show.html.rb
+<h2>Buttons</h2>
+<% @buttons.each do |button| %>
+  Button ID: <% button.id %>
+  Button Name: <% button.name %>
+<% end %>
+```
+
+######Accepted Query String Parameters
+
+Usabilla excepts the following query string parameters as values;
+
+Returns the requested subset.
+```
+?limit=
+```
+Returns the requested subset.
+```
+?since= 
+```
+Note: Only accepts Unix Timestamps
+
+#Contributing
+Feel free to fork or branch and create pull requests with any changes or cool additions!
+Be sure to test any changes and include them in the pull request in order for it to be considered.
+
+Thanks!
+
+
+######TODO
+* Testing
+* Refactoring
+
+*isn't this always the case though?* ~_^

data/lib/usabilla_api/clients/button.rb

@@ -0,0 +1,29 @@
+require 'json'
+
+module UsabillaApi
+  module Clients
+    class Button
+      class << self
+
+        def retrieve(params)
+          request = UsabillaApi.api_client.new(params).get_buttons
+          request = UsabillaApi.response.new(JSON.parse(request)).buttons unless return_json_response
+          request
+        end
+
+        def feedback(params)
+          request = UsabillaApi.api_client.new(params).get_feedback_items
+          request = UsabillaApi.response.new(JSON.parse(request)).feedback_items unless return_json_response
+          request
+        end
+
+        private
+
+        def return_json_response
+          UsabillaApi.configuration.json_response
+        end
+
+      end
+    end
+  end
+end

data/lib/usabilla_api/clients/campaign.rb

@@ -0,0 +1,29 @@
+require 'json'
+
+module UsabillaApi
+  module Clients
+    class Campaign
+      class << self
+
+        def retrieve(params)
+          request = UsabillaApi.api_client.new(params).get_campaigns
+          request = UsabillaApi.response.new(JSON.parse(request)).campaign unless return_json_response
+          request
+        end
+
+        def results(params)
+          request = UsabillaApi.api_client.new(params).get_campaign_results
+          request = UsabillaApi.response.new(JSON.parse(request)).campaign_results unless return_json_response
+          request
+        end
+
+        private
+
+        def return_json_response
+          UsabillaApi.configuration.json_response
+        end
+
+      end
+    end
+  end
+end

data/lib/usabilla_api/config.rb

@@ -0,0 +1,43 @@
+module UsabillaApi
+  class Config
+
+    def initialize
+      set_defaults
+    end
+
+    def set_base_uri(uri)
+      @base_uri = uri
+    end
+
+    protected
+    #################################################################
+
+    def set_defaults
+      @access_key                   = nil
+      @secret_key                   = nil
+      @http_method                  = 'GET'
+      @host_protocol                = 'https://'
+      @host                         = 'data.usabilla.com'
+      @base_scope                   = '/live/website'
+      @base_uri                     = @host_protocol + @host + @base_scope
+      @json_response                = false
+      set_default_api_uris
+      set_attr_accessors
+    end
+
+    private
+    #################################################################
+
+    def set_default_api_uris
+      @uri_button                 ||= '/button'
+      @uri_feedback_items         ||= '/button/:id/feedback'
+      @uri_campaign               ||= '/campaign'
+      @uri_campaign_results       ||= '/campaign/:id/results'
+    end
+
+    def set_attr_accessors
+      instance_variables.each { |instance_variable| self.class.send :attr_accessor, instance_variable[1..-1].to_sym }
+    end
+
+  end
+end

data/lib/usabilla_api/convenience.rb

@@ -0,0 +1,30 @@
+module UsabillaApi
+  module Convenience
+    module ClassMethods
+
+      def api_client
+        UsabillaApi::Client
+      end
+
+      def response
+        UsabillaApi::Models::Response
+      end
+
+      def button(params)
+        UsabillaApi::Clients::Button.retrieve(params)
+      end
+
+      def feedback_items(params)
+        UsabillaApi::Clients::Button.feedback(params)
+      end
+
+      def campaign(params)
+        UsabillaApi::Clients::Campaign.retrieve(params)
+      end
+
+      def campaign_results(params)
+        UsabillaApi::Clients::Campaign.results(params)
+      end
+    end
+  end
+end

data/lib/usabilla_api/models/button/item.rb

@@ -0,0 +1,15 @@
+module UsabillaApi
+  module Models
+    module Button
+      class Item
+        attr_accessor :id, :name
+
+        def initialize(args = {})
+          @id             = args['id'] || ''
+          @name           = args['name'] || ''
+        end
+
+      end
+    end
+  end
+end

data/lib/usabilla_api/models/campaign/item.rb

@@ -0,0 +1,24 @@
+module UsabillaApi
+  module Models
+    module Campaign
+      class Item
+        attr_accessor :id, :date, :button_id, :analytics_id, :status, :name, :statistics, :type
+
+        def initialize(args = {})
+          @id             = args['id'] || ''
+          @date           = args['date'] || ''
+          @button_id      = args['buttonId'] || ''
+          @analytics_id   = args['analyticsId'] || ''
+          @status         = args['status'] || ''
+          @name           = args['name'] || ''
+          @statistics     = create_statistics(args['statistics']) || []
+          @type           = args['type'] || ''
+        end
+
+        def create_statistics(hash)
+          UsabillaApi::Models::Campaign::Statistics.new(hash)
+        end
+      end
+    end
+  end
+end

data/lib/usabilla_api/models/campaign/statistics.rb

@@ -0,0 +1,17 @@
+module UsabillaApi
+  module Models
+    module Campaign
+      class Statistics
+
+        attr_accessor :views, :completed, :conversion
+
+        def initialize(args = {})
+          @views            = args['views'] || nil
+          @completed        = args['completed'] || nil
+          @conversion       = args['conversion'] || nil
+        end
+
+      end
+    end
+  end
+end

data/lib/usabilla_api/models/campaign_results/item.rb

@@ -0,0 +1,22 @@
+module UsabillaApi
+  module Models
+    module CampaignResults
+      class Item
+        attr_accessor :id, :user_agent, :location, :date, :campaign_id, :custom_data, :data, :url, :time
+
+        def initialize(args = {})
+          @id             = args['id'] || ''
+          @user_agent     = args['userAgent'] || ''
+          @location       = args['location'] || ''
+          @date           = args['date'] || ''
+          @campaign_id    = args['campaignId'] || ''
+          @custom_data    = args['customData'] || []
+          @data           = args['data'] || []
+          @url            = args['url'] || ''
+          @time           = args['time'] || nil
+        end
+
+      end
+    end
+  end
+end

data/lib/usabilla_api/models/feedback/item.rb

@@ -0,0 +1,28 @@
+module UsabillaApi
+  module Models
+    module Feedback
+      class Item
+        attr_accessor :id, :user_agent, :comment, :location, :date, :custom, :email, :image, :labels, :nps, :public_url, :rating, :button_id, :tags, :url
+
+        def initialize(args = {})
+          @id             = args['id'] || ''
+          @user_agent     = args['userAgent'] || ''
+          @comment        = args['comment'] || ''
+          @location       = args['location'] || ''
+          @date           = args['date'] || ''
+          @custom         = args['custom'] || []
+          @email          = args['email'] || ''
+          @image          = args['image'] || ''
+          @labels         = args['labels'] || []
+          @nps            = args['nps'] || nil
+          @public_url     = args['publicUrl'] || []
+          @rating         = args['rating'] || ''
+          @button_id      = args['buttonId'] || nil
+          @tags           = args['tags'] || []
+          @url            = args['url'] || ''
+        end
+
+      end
+    end
+  end
+end

data/lib/usabilla_api/models/response.rb

@@ -0,0 +1,30 @@
+module UsabillaApi
+  module Models
+    class Response
+      attr_accessor :items, :count, :has_more, :last_time_stamp
+
+      def initialize(args = {})
+        @items                 = args['items'] || Array.new
+        @count                 = args['count'] || 0
+        @has_more              = args['hasMore'] || false
+        @last_time_stamp       = args['lastTimestamp'] || nil
+      end
+
+      def buttons
+        @items = @items.map {|item| UsabillaApi::Models::Button::Item.new(item)} unless @items.nil?
+      end
+
+      def feedback_items
+        @items = @items.map {|item| UsabillaApi::Models::Feedback::Item.new(item)} unless @items.nil?
+      end
+
+      def campaign
+        @items = @items.map {|item| UsabillaApi::Models::Campaign::Item.new(item)} unless @items.nil?
+      end
+
+      def campaign_results
+        @items = @items.map {|item| UsabillaApi::Models::Campaign::Item.new(item)} unless @items.nil?
+      end
+    end
+  end
+end

data/lib/usabilla_api/usabilla_api.rb

@@ -0,0 +1,100 @@
+require 'rest-client'
+require 'openssl'
+
+module UsabillaApi
+
+  class Client
+    attr_accessor :http_method, :host, :host_protocol, :access_key, :secret_key, :query_parameters
+
+    def initialize(params)
+      @http_method        = UsabillaApi.configuration.http_method
+      @host_protocol      = UsabillaApi.configuration.host_protocol
+      @host               = UsabillaApi.configuration.host
+      @base_scope         = UsabillaApi.configuration.base_scope
+      @access_key         = UsabillaApi.configuration.access_key
+      @secret_key         = UsabillaApi.configuration.secret_key
+      @query_parameters   = params || ''
+      @query_id           = @query_parameters["id"] || String.new
+    end
+
+    def get_buttons
+      send_signed_request(UsabillaApi.configuration.uri_button)
+    end
+
+    def get_feedback_items
+      if @query_id.nil? || @query_id.empty?
+        raise 'Invalid Button ID'
+      end
+      uri = sub_query_id(UsabillaApi.configuration.uri_feedback_items)
+      send_signed_request(uri)
+    end
+
+    def get_campaigns
+      send_signed_request(UsabillaApi.configuration.uri_campaign)
+    end
+
+    def get_campaign_results
+      if @query_id.nil? || @query_id.empty?
+        raise 'Invalid Campaign ID'
+      end
+      uri = sub_query_id(UsabillaApi.configuration.uri_campaign_results)
+
+      send_signed_request(uri)
+    end
+
+    private
+
+    def send_signed_request(uri)
+
+      if @access_key.nil? || @secret_key.nil?
+        raise 'Invalid Access Key. The Access Key supplied is invalid.'
+      end
+
+      t = DateTime.now
+      usbldate = t.strftime('%a, %d %b %Y %H:%M:%S GMT')
+      datestamp = t.strftime('%Y%m%d')  # Date w/o time, used in credential scope
+      long_date = t.strftime('%Y%m%dT%H%M%SZ')
+
+      query_string = build_query_string(@query_parameters)
+      canonical_headers = "date:#{usbldate}\nhost:#{@host}\n"
+      signed_headers = 'date;host'
+      payload_hash = OpenSSL::Digest::SHA256.new.hexdigest
+
+      canonical_request = "#{@http_method}\n#{@base_scope + uri}\n#{query_string}\n#{canonical_headers}\n#{signed_headers}\n#{payload_hash}"
+
+      canonical_request_digest = OpenSSL::Digest::SHA256.new(canonical_request).hexdigest
+      algorithm = 'USBL1-HMAC-SHA256'
+      credential_scope = "#{datestamp}/usbl1_request"
+
+      string_to_sign = "#{algorithm}\n#{long_date}\n#{credential_scope}\n#{canonical_request_digest}"
+
+      signing_key = get_signature_key(@secret_key, datestamp)
+      signature = OpenSSL::HMAC.hexdigest('sha256', signing_key, string_to_sign)
+
+      authorization_header = "#{algorithm} Credential=#{@access_key}/#{credential_scope}, SignedHeaders=#{signed_headers}, Signature=#{signature}"
+      headers = {'date' => usbldate, 'Authorization' => authorization_header}
+
+      # Send the request.
+      request_url = uri + '?' + query_string
+      response = RestClient.get(UsabillaApi.configuration.base_uri + request_url, headers)
+
+      # Return Response
+      response
+
+    end
+
+    def get_signature_key(key, long_date)
+      k_date    = OpenSSL::HMAC.digest('sha256', 'USBL1' + key, long_date)
+      k_signing = OpenSSL::HMAC.digest('sha256', k_date, 'usbl1_request')
+      k_signing
+    end
+
+    def sub_query_id(uri)
+      uri.gsub(':id', @query_id)
+    end
+
+    def build_query_string(hash)
+      hash.to_a.reverse.map { |x| "#{x[0]}=#{x[1]}" }.join("&") unless hash.nil?
+    end
+  end
+end

data/lib/usabilla_api/version.rb

@@ -0,0 +1,3 @@
+module UsabillaApi
+  VERSION = '0.1.1'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usabilla_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jon Molinaro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -44,6 +44,100 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rspec-pride
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 description: A Ruby Usabilla API Gem that will allow you to connect to and use the
   Usabilla API
 email: Teirson@gmail.com
@@ -51,7 +145,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/usabilla_api.rb
+- lib/usabilla_api/clients/button.rb
+- lib/usabilla_api/clients/campaign.rb
+- lib/usabilla_api/config.rb
+- lib/usabilla_api/convenience.rb
+- lib/usabilla_api/models/button/item.rb
+- lib/usabilla_api/models/campaign/item.rb
+- lib/usabilla_api/models/campaign/statistics.rb
+- lib/usabilla_api/models/campaign_results/item.rb
+- lib/usabilla_api/models/feedback/item.rb
+- lib/usabilla_api/models/response.rb
+- lib/usabilla_api/usabilla_api.rb
+- lib/usabilla_api/version.rb
 homepage: http://rubygems.org/gems/usabilla_api
 licenses:
 - MIT