access 2.0.15 → 2.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76f8101646132407a45dce5cb4879ce4e152251d
-  data.tar.gz: 5606f03d1dfbb338f83807ff5301a4913df2f681
+  metadata.gz: c0a44d1813d284be301a7fa6fca93de4d8ef4c2c
+  data.tar.gz: 512e5ee78e609bb65db7c52997fcaab19f375433
 SHA512:
-  metadata.gz: d2889e260231f3c6ef2f2cde036e51e0b63ca8011a3700898ba6c39e4b4dc8f2a345ad4b84ac54f1d31b4d6db6e17997e144f44f5f33face66ab070f23438d81
-  data.tar.gz: 980a0c9afd21bd4b5bcf95da601525bf9f6574b7d14f919e5fbbf194617ea54386fa0dc7e6f758801e527c30992261287905e77f7ccbdcb444e76e639f723750
+  metadata.gz: a22a8593a0caebcbb234c693d5ecd2bdec8c7da232f80654315eef52ec8f3b7d396538297c09eb1ea1420c522469a8e1975d9412e7554d237706c49e231983c9
+  data.tar.gz: e63cd07b6505b6281aec0fa93917f4b6cb6c65f58671b8b7be6d3313c46729b50bd539910da96cf785d0a45e1fa46b3397e829e912beae6aa4244441c69abc92

data/lib/access.rb

@@ -11,6 +11,7 @@ require "access/category"
 require "access/channel"
 require "access/city_savings"
 require "access/error"
+require "access/favorite"
 require "access/filter"
 require "access/geolocation"
 require "access/info"

data/lib/access/api.rb

@@ -309,6 +309,31 @@ module Access
       end
     end
 
+    ## Favorites
+
+    def favorites_search(options = {})
+      request.get("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}", "mms", options) do |response|
+        FavoriteResponse.new(response)
+      end
+    end
+
+    def favorites_find(resource_id, options = {})
+      request.get("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}/#{resource_id}", "mms", options) do |response|
+        FavoriteResponse.new(response)
+      end
+    end
+
+    def favorites_create(resource_id, options = {})
+      request.post("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}/#{resource_id}", "mms", options) do |response|
+        FavoriteResponse.new(response)
+      end
+    end
+
+    def favorites_delete(resource_id, options = {})
+      request.delete("/members/#{options[:member_key]}/favorites/#{options[:favorite_type]}/#{resource_id}", "mms", options) do |response|
+        FavoriteResponse.new(response)
+      end
+    end
     private
 
     def request

data/lib/access/favorite.rb

@@ -0,0 +1,72 @@
+module Access
+  class Favorite
+
+    def self.process_batch(chunk)
+      chunk.map { |favorite| new(favorite) }
+    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
+    end
+
+    def resource
+      self.send(self.favoriteType)
+    end
+
+    def self.search(options = {})
+      Access::Api.new.favorites_search options
+    end
+
+    def self.search_offers(options = {})
+      Access::Api.new.favorites_search options.merge(favorite_type: 'offers')
+    end
+
+    def self.search_locations(options = {})
+      Access::Api.new.favorites_search options.merge(favorite_type: 'locations')
+    end
+
+    def self.search_stores(options = {})
+      Access::Api.new.favorites_search options.merge(favorite_type: 'stores')
+    end
+
+    def self.find_offer(offer_key, options = {})
+      Access::Api.new.favorites_find offer_key, options.merge(favorite_type: 'offers')
+    end
+
+    def self.find_location(location_key, options = {})
+      Access::Api.new.favorites_find location_key, options.merge(favorite_type: 'locations')
+    end
+
+    def self.find_store(store_key, options = {})
+      Access::Api.new.favorites_find store_key, options.merge(favorite_type: 'stores')
+    end
+
+    def self.create_offer(offer_key, options = {})
+      Access::Api.new.favorites_create offer_key, options.merge(favorite_type: 'offers')
+    end
+
+    def self.create_location(location_key, options = {})
+      Access::Api.new.favorites_create location_key, options.merge(favorite_type: 'locations')
+    end
+
+    def self.create_store(store_key, options = {})
+      Access::Api.new.favorites_create store_key, options.merge(favorite_type: 'stores')
+    end
+
+    def self.delete_offer(offer_key, options = {})
+      Access::Api.new.favorites_delete offer_key, options.merge(favorite_type: 'offers')
+    end
+
+    def self.delete_location(location_key, options = {})
+      Access::Api.new.favorites_delete location_key, options.merge(favorite_type: 'locations')
+    end
+
+    def self.delete_store(store_key, options = {})
+      Access::Api.new.favorites_delete store_key, options.merge(favorite_type: 'stores')
+    end
+
+  end
+end

data/lib/access/request.rb

@@ -31,6 +31,21 @@ module Access
       raise Access::Error::NoData
     end
 
+    def delete(path, api_type, options={}, &block)
+      url = set_base(api_type, path)
+      results = self.class.delete(url, headers: headers(options[:access_token]), body: options.to_json, timeout: (options[:access_timeout] || 10))
+      if should_return_json?(options[:return_json])
+        hashify_results?(options[:hashify]) ? results.hashify : results
+      else
+        block.call results
+      end
+    rescue Net::ReadTimeout, Net::OpenTimeout
+      # block.call({"message"=>"Request Timeout Error", "status"=>408})
+      raise Access::Error::Timeout
+    rescue EOFError
+      raise Access::Error::NoData
+    end
+
     def post_for_filter(path, api_type, filter, options={}, &block)
       url = set_base(api_type, path)
       results = self.class.post(url, headers: headers(options[:access_token]), body: filter, timeout: (options[:access_timeout] || 3))

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, :offer_redemptions
+    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, :favorites
 
     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
@@ -159,4 +159,9 @@ module Access
     end
   end
 
+  class FavoriteResponse < Response
+    def process_data
+      @favorites = Access::Favorite.process_batch(@favorites) if @favorites
+    end
+  end
 end

data/lib/access/spot.rb

@@ -2,15 +2,15 @@ module Access
   class Spot
 
     def self.search_by_channel(channel_key, options = {})
-      Access::api.new.search_spots_by_channel channel_key, options
+      Access::Api.new.search_spots_by_channel channel_key, options
     end
 
     def self.search_by_campaign(campaign_key, options = {})
-      Access::api.new.search_spots_by_campaign campaign_key, options
+      Access::Api.new.search_spots_by_campaign campaign_key, options
     end
 
     def self.find(spot_key, options = {})
-      Access::api.new.find_spot spot_key, options
+      Access::Api.new.find_spot spot_key, options
     end
 
     def self.process_batch(chunk)

data/lib/access/version.rb

@@ -1,4 +1,4 @@
 module Access
-  VERSION = "2.0.15"
+  VERSION = "2.0.17"
 end
 

data/test/access/favorite_test.rb

@@ -0,0 +1,181 @@
+require './test/test_helper'
+
+class FavoriteTest < Minitest::Test
+
+  def self.setup_favorites
+    VCR.use_cassette('favorite one of everything') do
+      @offer = Access::Offer.search(member_key: 'API_TEST', access_token: 'token_without_filters_with_program_offers', query: '_exists_:program_keys', all_offers: 'true').offers.first
+      # make sure there is a member that exists first
+      Access::Redeem.redeem_offer(@offer.offer_key, @offer.redemption_methods.first, member_key: "API_TEST", access_timeout: 10)
+      # make sure there is an offer favorited first
+      Access::Favorite.create_offer @offer.offer_key, member_key: 'API_TEST'
+      Access::Favorite.create_location @offer.location.location_key, member_key: 'API_TEST'
+      Access::Favorite.create_store @offer.store.store_key, member_key: 'API_TEST'
+    end
+    @offer
+  end
+
+  @@offer = FavoriteTest.setup_favorites
+
+  def test_favorite_search
+    VCR.use_cassette('favorite search') do
+      request = Access::Favorite.search member_key: 'API_TEST'
+      assert request.success
+      assert_kind_of Access::FavoriteResponse, request
+      assert_kind_of Array, request.favorites
+      assert request.favorites.map(&:favoriteType).uniq.count > 1, 'it should have more than one favorite type (offers/stores/locations)'
+      assert_kind_of Access::Favorite, request.favorites.first
+    end
+  end
+
+  def test_favorite_resource_links_to_the_object
+    favorite = Access::Favorite.new favoriteType: 'location', favorited_date: Time.now, location: {location_key: 123}
+    assert_equal favorite.resource, favorite.location
+  end
+
+  def test_favorite_search_with_bad_member
+    VCR.use_cassette('favorite search bad member') do
+      request = Access::Favorite.search member_key: 'API_TEST_FAVORITE_BAD_MEMBER'
+      refute request.success
+      assert_equal 400, request.status
+      assert_kind_of Access::FavoriteResponse, request
+      refute_nil request.error
+      assert_kind_of Access::Error, request.error
+    end
+  end
+
+  def test_favorite_search_with_no_favorites
+    # TODO refactor after fav api update
+    VCR.use_cassette('favorite search no favorites') do
+      request = Access::Favorite.search member_key: 'API_TEST_FAVORITE_NO_FAVORITES'
+      refute request.success
+      assert_kind_of Access::FavoriteResponse, request
+      refute_nil request.error
+      assert_kind_of Access::Error, request.error
+    end
+  end
+
+  def test_favorite_search_offers
+    VCR.use_cassette('favorite search offers') do
+      request = Access::Favorite.search_offers member_key: 'ALD12345'
+      assert_good_favorite_offer_response(request)
+    end
+  end
+
+  def test_favorite_search_locations
+    VCR.use_cassette('favorite search locations') do
+      request = Access::Favorite.search_locations member_key: 'ALD12345'
+      assert_good_favorite_location_response(request)
+    end
+  end
+
+  def test_favorite_search_stores
+    VCR.use_cassette('favorite search stores') do
+      request = Access::Favorite.search_stores member_key: 'ALD12345'
+      assert_good_favorite_store_response(request)
+    end
+  end
+
+  def test_favorite_find_offer
+    VCR.use_cassette('favorite find offer') do
+      Access::Favorite.create_offer @@offer.offer_key, member_key: 'API_TEST' # create it first, in case it was deleted
+      request = Access::Favorite.find_offer @@offer.offer_key, member_key: 'API_TEST'
+      assert_good_favorite_offer_response(request)
+    end
+  end
+
+  def test_favorite_find_location
+    VCR.use_cassette('favorite find location') do
+      Access::Favorite.create_location @@offer.location.location_key, member_key: 'API_TEST' # create it first, in case it was deleted
+      request = Access::Favorite.find_location @@offer.location.location_key, member_key: 'API_TEST'
+      assert_good_favorite_location_response(request)
+    end
+  end
+
+  def test_favorite_find_store
+    VCR.use_cassette('favorite find store') do
+      Access::Favorite.create_store @@offer.store.store_key, member_key: 'API_TEST' # create it first, in case it was deleted
+      request = Access::Favorite.find_store @@offer.store.store_key, member_key: 'API_TEST'
+      assert_good_favorite_store_response(request)
+    end
+  end
+
+  def test_favorite_create_offer
+    VCR.use_cassette('favorite create offer') do
+      request = Access::Favorite.create_offer @@offer.offer_key, member_key: 'API_TEST'
+      assert_good_favorite_offer_response(request)
+    end
+  end
+
+
+  def test_favorite_create_location
+    VCR.use_cassette('favorite create location') do
+      request = Access::Favorite.create_location @@offer.location.location_key, member_key: 'API_TEST'
+      assert_good_favorite_location_response(request)
+    end
+  end
+
+  def test_favorite_create_store
+    VCR.use_cassette('favorite create store') do
+      request = Access::Favorite.create_store @@offer.store.store_key, member_key: 'API_TEST'
+      assert_good_favorite_store_response(request)
+    end
+  end
+
+  def test_favorite_delete_offer
+    VCR.use_cassette('favorite delete offer') do
+      Access::Favorite.create_offer @@offer.offer_key, member_key: 'API_TEST' # create it first, in case it was deleted
+      request = Access::Favorite.delete_offer @@offer.offer_key, member_key: 'API_TEST'
+      assert request.success
+      assert_kind_of Access::FavoriteResponse, request
+    end
+  end
+
+  def test_favorite_delete_location
+    VCR.use_cassette('favorite delete location') do
+      Access::Favorite.delete_location @@offer.location.location_key, member_key: 'API_TEST' # create it first, in case it was deleted
+      request = Access::Favorite.find_location @@offer.location.location_key, member_key: 'API_TEST'
+      assert request.success
+      assert_kind_of Access::FavoriteResponse, request
+    end
+  end
+
+  def test_favorite_delete_store
+    VCR.use_cassette('favorite delete store') do
+      Access::Favorite.delete_store @@offer.store.store_key, member_key: 'API_TEST' # create it first, in case it was deleted
+      request = Access::Favorite.find_store @@offer.store.store_key, member_key: 'API_TEST'
+      assert request.success
+      assert_kind_of Access::FavoriteResponse, request
+    end
+  end
+
+
+  def assert_good_favorite_offer_response(request)
+    assert request.success
+    assert_kind_of Access::FavoriteResponse, request
+    assert_kind_of Array, request.favorites
+    assert_equal 1, request.favorites.map(&:favoriteType).uniq.count
+    assert_equal 'offer', request.favorites.map(&:favoriteType).uniq.first
+    assert_kind_of Access::Favorite, request.favorites.first
+  end
+
+  def assert_good_favorite_location_response(request)
+    assert request.success
+    assert_kind_of Access::FavoriteResponse, request
+    assert_kind_of Array, request.favorites
+    assert_equal 1, request.favorites.map(&:favoriteType).uniq.count
+    assert_equal 'location', request.favorites.map(&:favoriteType).uniq.first
+    assert_kind_of Access::Favorite, request.favorites.first
+  end
+
+  def assert_good_favorite_store_response(request)
+    assert request.success
+    assert_kind_of Access::FavoriteResponse, request
+    assert_kind_of Array, request.favorites
+    assert_equal 1, request.favorites.map(&:favoriteType).uniq.count
+    assert_equal 'store', request.favorites.map(&:favoriteType).uniq.first
+    assert_kind_of Access::Favorite, request.favorites.first
+  end
+
+end
+

data/test/access/member_test.rb

@@ -2,4 +2,61 @@ require './test/test_helper'
 
 class MemberTest < Minitest::Test
 
+  def test_register_success
+    VCR.use_cassette('member register success') do
+      request = Access::Member.register registration_params
+      assert request.success
+      assert_kind_of Access::MemberResponse, request
+      assert_kind_of Array, request.users
+      assert_equal 1, request.users.count
+      assert_kind_of Access::Member, request.users.first
+    end
+  end
+
+  def test_register_failure
+    VCR.use_cassette('member register failure') do
+      request = Access::Member.register registration_params.merge(email: nil)
+      refute request.success
+      assert_equal 400, request.status
+      assert_kind_of Access::MemberResponse, request
+      refute_nil request.error
+      assert_kind_of Access::Error, request.error
+    end
+  end
+
+  def test_authenticate_success
+    VCR.use_cassette('member authenticate success') do
+      request = Access::Member.authenticate email: 'ben@test.com', password: 'password'
+      assert request.success
+      assert_kind_of Access::MemberResponse, request
+      assert_kind_of Array, request.users
+      assert_equal 1, request.users.count
+      assert_kind_of Access::Member, request.users.first
+    end
+  end
+
+  def test_authenticate_failure
+    VCR.use_cassette('member authenticate failure') do
+      request = Access::Member.authenticate email: 'ben@test.com', password: 'bad'
+      refute request.success
+      assert_equal 401, request.status
+      assert_kind_of Access::MemberResponse, request
+      refute_nil request.error
+      assert_kind_of Access::Error, request.error
+    end
+  end
+
+  def registration_params
+    {
+      program_id: 2412,
+      first_name: 'RubyGem',
+      last_name: 'Test',
+      postal_code: 84047,
+      email: "rubygemtest-3@accessdevelopment.com",
+      password: 'test1234',
+      shared_secret: 'thanks',
+      program_url: "saversclub.accessdevelopment.com",
+      access_timeout: 180
+    }
+  end
 end

data/test/access/oauth_application_test.rb

@@ -74,18 +74,18 @@ class OauthApplicationTest < Minitest::Test
   end
 
   def test_oauth_applications_create_token
-
+    skip
   end
 
   def test_oauth_applications_create
-
+    skip
   end
 
   def test_oauth_applications_update
-
+    skip
   end
 
   def test_oauth_applications_delete
-
+    skip
   end
 end