access 2.0.11 → 2.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 085579424366d9a40605ffb727ff40eb3b806487
-  data.tar.gz: a48cd1109596db44bfe7808e020bc563123d8537
+  metadata.gz: 0ec93230386c5fab3046bd406a7e15d32dfc8ba5
+  data.tar.gz: 5511ac00dcc0e85e9f160ef4ec7dd513a53f3f02
 SHA512:
-  metadata.gz: 9f2070fd1ebbee4b81ed1af617fbcb90e7635d711dde0365360f2f568bce059ca6b6787f9faa55a9edd3fa1d899ebde68a989a86e938b9fd5408aab02f87741c
-  data.tar.gz: 9fb76dc5c2f11ae1eab40ffc8775838770df84f89db047065defcd51fed562c6848b3e15079b9e67495069175cb3bf42d94ee77a7b9277629057d884523bd99b
+  metadata.gz: ea5df8c2f50a5e9094c0347ceb9d7ccf27033dbf412af11f18576bf4b9f609b15f6a520951446f628007c63cca89d98891dd95166e8f9f0bec25e905bce4dc79
+  data.tar.gz: 517e30a0c574b6d5f39a5e6f013941cc995231eb340e6a07691d32bc333a68cc38efc6abd6e76dd53a8ddaaf5a6e32d1011ec3e769eff2fcf35b4628d71a8df7

data/Rakefile

@@ -11,5 +11,5 @@ end
 task default: :test
 
 task :clear_vcr do
-  `rm test/fixtures/*.yml`
+  `rm test/vcr/cassettes/*.yml`
 end

data/lib/access.rb

@@ -20,6 +20,7 @@ require "access/member"
 require "access/oauth_application"
 require "access/offer"
 require "access/redeem"
+require "access/redemption"
 require "access/report"
 require "access/request"
 require "access/response"

data/lib/access/api.rb

@@ -129,7 +129,7 @@ module Access
     # Member
     def member_registration(options = {})
       request.post("/register", "mms", options) do |response|
-        MemberRegistrationResponse.new(response)
+        MemberResponse.new(response)
       end
     end
 
@@ -139,6 +139,20 @@ module Access
       end
     end
 
+    # Offer Redemptions
+
+    def search_offer_redemptions_by_member(member_key, options = {})
+      request.get("/members/#{member_key}/offer-redemptions", "report", options) do |response|
+        RedemptionResponse.new(response)
+      end
+    end
+
+    def find_offer_redemptions_by_member(member_key, usage_redeem_key, options = {})
+      request.get("/members/#{member_key}/offer-redemptions/#{usage_redeem_key}", "report", options) do |response|
+        RedemptionResponse.new(response)
+      end
+    end
+
     # Internal Admin only Call Below
 
     # Filters

data/lib/access/redemption.rb

@@ -0,0 +1,26 @@
+module Access
+  class Redemption
+
+    def self.search_by_member(member_key, options = {})
+      Access::Api.new.search_offer_redemptions_by_member member_key, options
+    end
+
+    def self.find_by_member(member_key, usage_redeem_key, options = {})
+      Access::Api.new.find_offer_redemptions_by_member member_key, usage_redeem_key, options
+    end
+
+    def self.process_batch(chunk)
+      chunk.map { |redemption| new(redemption) }
+    end
+
+    def initialize(values)
+      self.class.class_eval {attr_reader *values.keys }
+      values.each do |attribute_name, attribute_value|
+        self.instance_variable_set("@#{attribute_name}", attribute_value)
+      end
+      @offer = Access::Offer.new(@offer)
+      @member = Access::Member.new(@member)
+    end
+
+  end
+end

data/lib/access/response.rb

@@ -1,7 +1,7 @@
 module Access
   class Response
 
-    attr_accessor :info, :offers, :stores, :locations, :categories, :suggestions, :oauth_applications, :access_tokens, :oauth_tokens, :oauth_token, :verify, :reports, :members, :filters, :links, :dev_node, :message, :status, :success, :error, :response_status, :content_type, :redemption_method, :details, :oauth_access_token, :api_calls_over_time, :member_usage, :offer_count_in_categories, :offer_count_by_redemption_method, :offer_count_by_facet, :custom_aggregation, :internal_details, :users, :response
+    attr_accessor :info, :offers, :stores, :locations, :categories, :suggestions, :oauth_applications, :access_tokens, :oauth_tokens, :oauth_token, :verify, :reports, :members, :filters, :links, :dev_node, :message, :status, :success, :error, :response_status, :content_type, :redemption_method, :details, :oauth_access_token, :api_calls_over_time, :member_usage, :offer_count_in_categories, :offer_count_by_redemption_method, :offer_count_by_facet, :custom_aggregation, :internal_details, :users, :response, :offer_redemptions
 
     def initialize(response)
       @response = response # Setting this temporarily so i can have a working member reg call, since it doesn't follow the resource [] best practices
@@ -111,17 +111,11 @@ module Access
     def process_data
       @api_calls_over_time = Access::Report.process_batch(@api_calls_over_time) if @api_calls_over_time
       @member_query_terms = Access::Report.process_batch(@member_query_terms) if @member_query_terms
+      @member_usage = Access::Report.process_batch(@member_usage) if @member_usage
       @member_postal_codes = Access::Report.process_batch(@member_postal_codes) if @member_postal_codes
     end
   end
 
-  class MemberRegistrationResponse < Response
-    def process_data
-      @users = Access::Member.process_batch([@response])
-    end
-  end
-
-
   class MemberResponse < Response
     def process_data
       @users = Access::Member.process_batch(@users)
@@ -158,6 +152,11 @@ module Access
     end
   end
 
-
+  class RedemptionResponse < Response
+    def process_data
+      (@offer_redemptions = []; create_error) if @message
+      @offer_redemptions = Access::Redemption.process_batch(@offer_redemptions)
+    end
+  end
 
 end

data/lib/access/version.rb

@@ -1,4 +1,4 @@
 module Access
-  VERSION = "2.0.11"
+  VERSION = "2.0.13"
 end
 

data/test/access/filter_test.rb

@@ -34,6 +34,8 @@ class FilterTest < Minitest::Test
       assert_kind_of Access::Filter, first_filter
       assert first_filter.json_filter
       assert first_filter.hash_filter
+      assert first_filter.filter_key
+      assert first_filter.name
     end
   end
 

data/test/access/offer_test.rb

@@ -44,9 +44,7 @@ class OfferTest < Minitest::Test
       offers_response = Access::Offer.search(query: 'pizza', member_key: 'API_RUBY_GEM_TEST', per_page: 1)
       first_offer = offers_response.offers.first
       assert offers_response.success
-      # location
       assert_equal first_offer.offer_store.physical_location, first_offer.location
-      # store
       assert_equal first_offer.offer_store, first_offer.store
     end
   end
@@ -69,4 +67,24 @@ class OfferTest < Minitest::Test
     assert_raises(Access::Error::NoAccessToken) { Access::Offer.search(query: 'pizza', member_key: 'API_RUBY_GEM_TEST') }
     Access.config.access_token = ENV['ACCESS_TOKEN'] = orginal_token
   end
+
+  def test_offers_with_aggregation
+    VCR.use_cassette('offer with aggregations') do
+      offers_response = Access::Offer.search(query: 'pizza', member_key: 'API_RUBY_GEM_TEST', aggregations: 'all_categories,stores,locations,redemption_methods')
+      assert offers_response.success
+      assert_kind_of Access::OfferResponse, offers_response
+      assert_kind_of Array, offers_response.offer_count_in_categories
+      assert_kind_of Access::Aggregations, offers_response.offer_count_in_categories.first
+      assert offers_response.offer_count_in_categories.first.category_name
+      assert_kind_of Array, offers_response.offer_count_in_categories.first.subcategories
+      assert_kind_of Access::Category, offers_response.offer_count_in_categories.first.subcategories.first
+      assert_kind_of Array, offers_response.offer_count_by_redemption_method
+      assert_kind_of Access::Aggregations, offers_response.offer_count_by_redemption_method.first
+      assert offers_response.offer_count_by_redemption_method.first.offer_count
+      assert offers_response.offer_count_by_redemption_method.first.redemption_method
+      assert offers_response.info.total_locations
+      assert offers_response.info.total_stores
+    end
+  end
+
 end

data/test/access/redeem_test.rb

@@ -24,7 +24,7 @@ class RedeemTest < Minitest::Test
 
   def test_redeem_offer_with_redeem_type
     get_first_offer
-    VCR.use_cassette('redeem offer no redeem type') do
+    VCR.use_cassette('redeem offer with redeem type') do
       redeem_response = Access::Redeem.redeem_offer(@first_offer.offer_key, @first_offer.redemption_methods.first, member_key: 'API_RUBY_GEM_TEST')
       assert redeem_response.success
       assert_kind_of Access::RedeemResponse, redeem_response

data/test/access/redemption_test.rb

@@ -0,0 +1,43 @@
+require './test/test_helper'
+
+class RedemptionTest < Minitest::Test
+
+  def get_first_redemption
+    VCR.use_cassette('search redemption by member key') do
+      @first_redemption = Access::Redemption.search_by_member('API_RUBY_GEM_TEST').offer_redemptions.first
+    end
+  end
+
+  def test_search_offer_redemptions_by_member
+    VCR.use_cassette('search redemption by member key') do
+      redemption_response = Access::Redemption.search_by_member('API_RUBY_GEM_TEST')
+      assert redemption_response.success
+      assert_kind_of Access::RedemptionResponse, redemption_response
+      assert_kind_of Access::Offer, redemption_response.offer_redemptions.first.offer
+      assert_kind_of Access::Member, redemption_response.offer_redemptions.first.member
+      assert_kind_of Access::Link, redemption_response.links
+    end
+  end
+
+  def test_find_offer_redemptions_by_member
+    get_first_redemption
+    VCR.use_cassette('find redemption by member key') do
+      redemption_response = Access::Redemption.find_by_member('API_RUBY_GEM_TEST', @first_redemption.usage_redeem_key)
+      assert redemption_response.success
+      assert_kind_of Access::RedemptionResponse, redemption_response
+      assert_kind_of Access::Offer, redemption_response.offer_redemptions.first.offer
+      assert_kind_of Access::Member, redemption_response.offer_redemptions.first.member
+    end
+  end
+
+  def test_search_offer_redemptions_by_member_with_no_redemptions
+    VCR.use_cassette('search redemption by member key without redemptions') do
+      redemption_response = Access::Redemption.search_by_member('API_RUBY_GEM_TEST_NOREDEMPTIONS')
+      refute redemption_response.success
+      assert_kind_of Access::RedemptionResponse, redemption_response
+      assert_kind_of Access::Error, redemption_response.error
+      assert_equal 200, redemption_response.error.status_code
+      assert_equal "No redemptions found.", redemption_response.error.message
+    end
+  end
+end

data/test/access/report_test.rb

@@ -2,35 +2,82 @@ require './test/test_helper'
 
 class ReportTest < Minitest::Test
 
-  # def get_first_report
-  #   VCR.use_cassette('report search') do
-  #     @first_report = Access::Report.search(member_key: 'API_RUBY_GEM_TEST', per_page: 1).reports.first
-  #   end
-  # end
-
-  # def test_reports_search
-  #   VCR.use_cassette('report search') do
-  #     reports_response = Access::Report.search(member_key: 'API_RUBY_GEM_TEST', per_page: 1)
-  #     assert reports_response.success
-  #     first_report = reports_response.reports.first
-  #     assert_kind_of Access::ReportResponse, reports_response
-  #     assert_kind_of Access::Link, reports_response.links
-  #     assert_kind_of Access::Info, reports_response.info
-  #     assert_kind_of Array, reports_response.reports
-  #     assert_kind_of Access::Report, first_report
-  #     assert_kind_of Access::Link, first_report.links
-  #   end
-  # end
-
-  # def test_reports_find
-  #   get_first_report
-  #   VCR.use_cassette('report find') do
-  #     reports_response = Access::Report.find(@first_report.report_key, member_key: 'API_RUBY_GEM_TEST')
-  #     assert reports_response.success
-  #     first_report = reports_response.reports.first
-  #     assert_kind_of Access::ReportResponse, reports_response
-  #     assert_kind_of Access::Report, first_report
-  #   end
-  # end
+  def test_all_usage
+    VCR.use_cassette('all usage') do
+      reports_response = Access::Report.all_usage
+      assert reports_response.success
+      assert_kind_of Access::Info, reports_response.info
+      assert_kind_of Array, reports_response.api_calls_over_time
+      assert_kind_of Access::Report, reports_response.api_calls_over_time.first
+    end
+  end
+
+  def test_usage
+    VCR.use_cassette('usage') do
+      reports_response = Access::Report.usage
+      assert reports_response.success
+      assert_kind_of Access::Info, reports_response.info
+      assert_kind_of Array, reports_response.api_calls_over_time
+      assert_kind_of Access::Report, reports_response.api_calls_over_time.first
+    end
+  end
+
+  def test_usage_other
+    VCR.use_cassette('usage other') do
+      reports_response = Access::Report.usage_other(ENV['ACCESS_TOKEN'])
+      assert reports_response.success
+      assert_kind_of Access::Info, reports_response.info
+      assert_kind_of Array, reports_response.api_calls_over_time
+      assert_kind_of Access::Report, reports_response.api_calls_over_time.first
+    end
+  end
+
+  def test_member_query_frequent
+    VCR.use_cassette('member query frequent') do
+      reports_response = Access::Report.member_query_frequent('API_RUBY_GEM_TEST')
+      assert reports_response.success
+      assert_kind_of Access::Info, reports_response.info
+      assert_kind_of Array, reports_response.member_usage
+      if reports_response.member_usage.first
+        assert_kind_of Access::Report, reports_response.member_usage.first
+      end
+    end
+  end
+
+  def test_member_query_recent
+    VCR.use_cassette('member query recent') do
+      reports_response = Access::Report.member_query_recent('API_RUBY_GEM_TEST')
+      assert reports_response.success
+      assert_kind_of Access::Info, reports_response.info
+      assert_kind_of Array, reports_response.member_usage
+      if reports_response.member_usage.first
+        assert_kind_of Access::Report, reports_response.member_usage.first
+      end
+    end
+  end
+
+  def test_member_location_frequent
+    VCR.use_cassette('member location frequent') do
+      reports_response = Access::Report.member_location_frequent('API_RUBY_GEM_TEST')
+      assert reports_response.success
+      assert_kind_of Access::Info, reports_response.info
+      assert_kind_of Array, reports_response.member_usage
+      if reports_response.member_usage.first
+        assert_kind_of Access::Report, reports_response.member_usage.first
+      end
+    end
+  end
+
+  def test_member_location_recent
+    VCR.use_cassette('member location recent') do
+      reports_response = Access::Report.member_location_recent('API_RUBY_GEM_TEST')
+      assert reports_response.success
+      assert_kind_of Access::Info, reports_response.info
+      assert_kind_of Array, reports_response.member_usage
+      if reports_response.member_usage.first
+        assert_kind_of Access::Report, reports_response.member_usage.first
+      end
+    end
+  end
 
 end

data/test/test_helper.rb

@@ -16,9 +16,11 @@ require 'vcr'
 
 
 VCR.configure do |c|
-  c.default_cassette_options = { record: ENV["RECORD"] ? ENV["RECORD"].to_sym  : :all }
-  # , match_requests_on: [:body]
-  c.cassette_library_dir = "test/fixtures"
+  c.default_cassette_options = { record: ENV["RECORD"] ? ENV["RECORD"].to_sym : :new_episodes, match_requests_on: [:body], erb: true }
+  c.cassette_library_dir = "test/vcr/cassettes"
   c.hook_into :webmock
   c.ignore_hosts 'codeclimate.com'
+  c.filter_sensitive_data('ACCESS_TOKEN') do
+    ENV['ACCESS_TOKEN']
+  end
 end

data/test/vcr/cassettes/all_usage.yml

@@ -0,0 +1,92 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://report-demo.adcrws.com/v1/all_usage
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Access-Token:
+      - ACCESS_TOKEN
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Origin,  X-Requested-With, Content-Type, Accept, Authorization, Access-Token
+      Access-Control-Allow-Methods:
+      - POST, GET, PUT, DELETE, OPTIONS
+      Access-Control-Max-Age:
+      - '1728000'
+      Access-Control-Request-Method:
+      - GET
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 06 Oct 2015 22:05:44 GMT
+      Etag:
+      - '"62515833526a161596f1c884cd337758"'
+      Server:
+      - nginx/1.6.2
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Request-Id:
+      - af9831ad-5cdf-44be-a399-d5393c1ed9a1
+      X-Runtime:
+      - '0.171561'
+      X-Xss-Protection:
+      - 1; mode=block
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "info": {
+            "total_api_calls": 74598,
+            "time_period": "2015-10-01T00:00:00Z to now",
+            "interval": "1d",
+            "report_env": "demo"
+          },
+          "api_calls_over_time": [
+            {
+              "timestamp": "2015-10-01T00:00:00.000",
+              "api_call_count": 13201
+            },
+            {
+              "timestamp": "2015-10-02T00:00:00.000",
+              "api_call_count": 12406
+            },
+            {
+              "timestamp": "2015-10-03T00:00:00.000",
+              "api_call_count": 11847
+            },
+            {
+              "timestamp": "2015-10-04T00:00:00.000",
+              "api_call_count": 11895
+            },
+            {
+              "timestamp": "2015-10-05T00:00:00.000",
+              "api_call_count": 12869
+            },
+            {
+              "timestamp": "2015-10-06T00:00:00.000",
+              "api_call_count": 12380
+            }
+          ]
+        }
+    http_version: 
+  recorded_at: Tue, 06 Oct 2015 22:05:44 GMT
+recorded_with: VCR 2.9.3