access 1.1.7 → 2.0.0

data/lib/access/request.rb

@@ -1,39 +1,44 @@
 module Access
   class Request
     include HTTParty
-    # debug_output $stdout # enable this to log all the requests
 
-
-    def get(path, api_type, options={})
-      set_format
-      results = self.class.get(set_base(api_type) + path, headers: headers, query: options)
-      handle_results(results)
+    def get(path, api_type, options={}, &block)
+      url = set_base(api_type, path)
+      results = self.class.get(url, headers: headers(options[:access_token]), query: options)
+      if should_return_json?(options[:return_json])
+        hashify_results?(options[:hashify]) ? results.hashify : results
+      else
+        block.call results
+      end
     end
 
-    def get_json(path, api_type, options={})
-      set_format
-      results = self.class.get(set_base(api_type) + path, headers: headers.merge({ 'Content-Type' => 'application/json', 'Accept' => 'application/json'}), body: options)
-      handle_results(results)
+    def get_for_filter(path, api_type, filter, options={}, &block)
+      url = set_base(api_type, path)
+      results = self.class.get(url, headers: headers(options[:access_token]), body: filter)
+      if should_return_json?(options[:return_json])
+        hashify_results?(options[:hashify]) ? results.hashify : results
+      else
+        block.call results
+      end
     end
 
     private
 
-    def handle_results(results)
-      Access.config.hashify == "true" ? results.hashify : results
+    def set_base(api_type, path)
+      "https://#{ api_type }#{ Access::Config::DOMAINS[Access.config.api_environment] }.adcrws.com/v1#{path}"
     end
 
-    def set_base(api_type)
-      "https://#{ api_type }#{ Access::Config::DOMAINS[Access.config.api_environment] }.adcrws.com/#{Access.config.api_version}"
+    def headers(token_param)
+      raise Access::Error::NoAccessToken if (access_token = token_param || Access.config.access_token).nil?
+      {"Access-Token" => access_token, 'Content-Type' => 'application/json', 'Accept' => 'application/json'}
     end
 
-    def set_format
-      raise Access::Error::InvalidResponseFormat unless [:json, :xml].include?(Access.config.format.to_sym)
-      self.class.format Access.config.format.to_sym
+    def should_return_json?(return_json_param)
+      return_json_param == 'true' || (return_json_param != 'false' && Access.config.return_json == 'true')
     end
 
-    def headers
-      raise Access::Error::NoAccessToken unless Access.config.access_token
-      {"Access-Token" => Access.config.access_token}
+    def hashify_results?(hashify_param)
+      hashify_param == 'true' || (hashify_param != 'false' && Access.config.hashify == 'true')
     end
 
   end

data/lib/access/response.rb

@@ -0,0 +1,127 @@
+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
+
+    def initialize(response)
+      response.each { |key, value| instance_variable_set("@#{key}", value) if self.class.instance_methods.include? key.to_sym }
+      @response_status = response.message
+      @status ||= response.code
+      check_success(response)
+      if @success
+        @info = Access::Info.new(@info) if @info
+        (@links = @links.is_a?(Array) ? Access::Link.process_batch(@links) : Access::Link.new(@links)) if @links
+        process_data
+      end
+
+    end
+
+    def check_success(response)
+      if response.success?
+        @success = true
+      else
+        create_error
+      end
+    end
+
+    def create_error
+      @success = false
+      @error = Access::Error.new(@response_status, @status, @message)
+      remove_instance_variable(:@message) if @message
+      remove_instance_variable(:@status)
+    end
+  end
+
+  class OfferResponse < Response
+    def process_data
+      # for when you search and it returns 0
+      (@offers = []; create_error) if @message
+      @offers = Access::Offer.process_batch(@offers)
+    end
+  end
+
+  class StoreResponse < Response
+    def process_data
+      (@stores = []; create_error) if @message
+      @stores = Access::Store.process_batch(@stores)
+    end
+  end
+
+  class LocationResponse < Response
+    def process_data
+      (@locations = []; create_error) if @message
+      @locations = Access::Location.process_batch(@locations)
+    end
+  end
+
+  class CategoryResponse < Response
+    def process_data
+      (@categories = []; create_error) if @message
+      @categories = Access::Category.process_batch(@categories)
+    end
+  end
+
+  class AutocompleteResponse < Response
+    def process_data
+      # (@suggestions = []; create_error) if @message
+      @suggestions = Access::Autocomplete.new(@suggestions)
+    end
+  end
+
+  class OauthApplicationResponse < Response
+    def process_data
+      (@oauth_applications = []; create_error) if @message
+      @oauth_applications = Access::OauthApplication.process_batch(@oauth_applications)
+    end
+  end
+
+  class TokenResponse < Response
+    def process_data
+      (create_error) if @message
+      @access_tokens = Access::Token.process_batch(@access_tokens) if @access_tokens
+      @oauth_tokens = Access::Token.process_batch(@oauth_tokens) if @oauth_tokens
+      @oauth_token = Access::Token.new(@oauth_token) if @oauth_token
+    end
+  end
+
+  class VerifyResponse < Response
+    def process_data
+      @oauth_access_token = Access::Verify.new(@oauth_access_token) if @oauth_access_token
+      @offers = Access::Verify.new(@offers) if @offers
+      @categories = Access::Verify.new(@categories) if @categories
+      @locations = Access::Verify.new(@locations) if @locations
+      @stores = Access::Verify.new(@stores) if @stores
+    end
+  end
+
+  class RedeemResponse < Response
+    def process_data
+      @details = Access::Redeem.new(@details) if @details
+    end
+  end
+
+  class ReportResponse < Response
+    def process_data
+      @reports = Access::Report.new(@reports)
+    end
+  end
+
+  class MemberResponse < Response
+    def process_data
+      @members = Access::Member.process_batch(@members)
+    end
+  end
+
+  class FilterResponse < Response
+    def process_data
+      @filters = Access::Filter.process_batch(@filters)
+    end
+  end
+
+  class CitySavingsResponse < Response
+    def process_data
+      # something?
+      # @members = Access::Member.process_batch(@members)
+    end
+  end
+end

data/lib/access/spot.rb

@@ -0,0 +1,28 @@
+module Access
+  class Spot
+
+    def self.search_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
+    end
+
+    def self.find(spot_key, options = {})
+      Access::api.new.find_spot spot_key, options
+    end
+
+    def self.process_batch(chunk)
+      chunk.map { |campaign| new(campaign) }
+    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
+
+  end
+end

data/lib/access/store.rb

@@ -5,13 +5,27 @@ module Access
       Access::Api.new.search_stores options
     end
 
-    def self.find(key, options = {})
-      Access::Api.new.find_store key, options
+    def self.find(store_key, options = {})
+      Access::Api.new.find_store store_key, options
     end
 
     def self.national(options = {})
       Access::Api.new.national_stores options
     end
 
+    def self.process_batch(chunk)
+      chunk.map { |store| new(store) }
+    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
+      @links = Access::Link.new(@links) if @links
+      @store_categories = Access::Category.process_batch(@store_categories) if @store_categories
+      @physical_location = Access::Location.new(@physical_location) if @physical_location
+    end
+
   end
 end

data/lib/access/token.rb

@@ -2,12 +2,30 @@ module Access
   class Token
 
     def self.search(options = {})
+      # Internal Admin only Call
       Access::Api.new.search_tokens options
     end
 
     def self.find(token, options = {})
+      # Internal Admin only Call
       Access::Api.new.find_token token, options
     end
 
+    def self.process_batch(chunk)
+      chunk.map { |token| new(token) }
+    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
+      @links = Access::Link.new(@links) if @links
+    end
+
+    def has_scope?
+
+    end
+
   end
 end

data/lib/access/verify.rb

@@ -5,8 +5,17 @@ module Access
       Access::Api.new.verify_token options
     end
 
-    def self.filter(options = {})
-      Access::Api.new.verify_filter options
+    def self.filter(filter, options = {})
+      Access::Api.new.verify_filter filter, options
+    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
+      @categories = Access::Category.process_batch(@categories) if @categories
+      @redemption_methods = Access::Redeem.process_batch(@redemption_methods) if @redemption_methods
     end
 
   end

data/lib/access/version.rb

@@ -1,4 +1,4 @@
 module Access
-  VERSION = "1.1.7"
+  VERSION = "2.0.0"
 end
 

data/test/access/autocomplete_test.rb

@@ -0,0 +1,53 @@
+require './test/test_helper'
+
+class AutocompleteTest < Minitest::Test
+
+  def test_autocompletes_search
+    VCR.use_cassette('autocomplete search') do
+      autocompletes_response = Access::Autocomplete.search(member_key: 'API_RUBY_GEM_TEST', per_page: 1)
+      assert autocompletes_response.success
+      assert_kind_of Access::AutocompleteResponse, autocompletes_response
+      assert_kind_of Access::Autocomplete, autocompletes_response.suggestions
+      assert_kind_of Access::Store, autocompletes_response.suggestions.stores.first
+      assert_kind_of Access::Location, autocompletes_response.suggestions.locations.first
+      assert_kind_of Access::Category, autocompletes_response.suggestions.categories.first
+      assert_kind_of Access::Offer, autocompletes_response.suggestions.offers.first
+    end
+  end
+
+  def test_autocompletes_search_offers
+    VCR.use_cassette('autocomplete search offers') do
+      autocompletes_response = Access::Autocomplete.search_offers(member_key: 'API_RUBY_GEM_TEST', per_page: 1)
+      assert autocompletes_response.success
+      assert_kind_of Array, autocompletes_response.suggestions.offers
+      assert_kind_of Access::Offer, autocompletes_response.suggestions.offers.first
+    end
+  end
+
+  def test_autocompletes_search_stores
+    VCR.use_cassette('autocomplete search stores') do
+      autocompletes_response = Access::Autocomplete.search_stores(member_key: 'API_RUBY_GEM_TEST', per_page: 1)
+      assert autocompletes_response.success
+      assert_kind_of Array, autocompletes_response.suggestions.stores
+      assert_kind_of Access::Store, autocompletes_response.suggestions.stores.first
+    end
+  end
+
+  def test_autocompletes_search_locations
+    VCR.use_cassette('autocomplete search locations') do
+      autocompletes_response = Access::Autocomplete.search_locations(member_key: 'API_RUBY_GEM_TEST', per_page: 1)
+      assert autocompletes_response.success
+      assert_kind_of Array, autocompletes_response.suggestions.locations
+      assert_kind_of Access::Location, autocompletes_response.suggestions.locations.first
+    end
+  end
+
+  def test_autocompletes_search_categories
+    VCR.use_cassette('autocomplete search categories') do
+      autocompletes_response = Access::Autocomplete.search_categories(member_key: 'API_RUBY_GEM_TEST', per_page: 1)
+      assert autocompletes_response.success
+      assert_kind_of Array, autocompletes_response.suggestions.categories
+      assert_kind_of Access::Category, autocompletes_response.suggestions.categories.first
+    end
+  end
+end

data/test/access/category_test.rb

@@ -0,0 +1,64 @@
+require './test/test_helper'
+
+class CategoryTest < Minitest::Test
+
+  def get_first_category
+    VCR.use_cassette('category search') do
+      @first_category = Access::Category.search(member_key: 'API_RUBY_GEM_TEST', per_page: 1).categories.first
+      @first_subcategory = Access::Category.search(member_key: 'API_RUBY_GEM_TEST', per_page: 1).categories.first.subcategories.first
+    end
+  end
+
+  def test_categories_search
+    VCR.use_cassette('category search') do
+      categories_response = Access::Category.search(member_key: 'API_RUBY_GEM_TEST', per_page: 1)
+      assert categories_response.success
+      first_category = categories_response.categories.first
+      assert_kind_of Access::CategoryResponse, categories_response
+      assert_kind_of Access::Link, categories_response.links
+      assert_kind_of Array, categories_response.categories
+      assert_kind_of Access::Category, first_category
+      assert_kind_of Access::Link, first_category.links
+      assert_kind_of Access::Category, first_category.subcategories.first
+    end
+  end
+
+  def test_categories_find
+    get_first_category
+    VCR.use_cassette('category find') do
+      categories_response = Access::Category.find(@first_category.category_key, member_key: 'API_RUBY_GEM_TEST')
+      assert categories_response.success
+      first_category = categories_response.categories.first
+      assert_kind_of Access::CategoryResponse, categories_response
+      assert_kind_of Access::Category, first_category
+      assert_kind_of Access::Link, first_category.links
+      assert_kind_of Access::Category, first_category.subcategories.first
+    end
+  end
+
+  def test_subcategories_find
+    get_first_category
+    VCR.use_cassette('subcategory find') do
+      categories_response = Access::Category.find(@first_subcategory.category_key, member_key: 'API_RUBY_GEM_TEST')
+      assert categories_response.success
+      first_category = categories_response.categories.first
+      assert_kind_of Access::CategoryResponse, categories_response
+      assert_kind_of Access::Category, first_category
+      assert_kind_of Access::Link, first_category.links
+      assert_kind_of Access::Category, first_category.subcategory_siblings.first
+    end
+  end
+
+  def test_categories_fail_member_key
+    VCR.use_cassette('category search fail member key') do
+      subcategories_response = Access::Category.search(query: 'pizza')
+      refute subcategories_response.success
+      assert_kind_of Access::CategoryResponse, subcategories_response
+      assert_kind_of Access::Error, subcategories_response.error
+      assert_equal 401,  subcategories_response.error.status_code
+      assert_equal "Must include a member_key to see details.",  subcategories_response.error.message
+      assert_equal "Unauthorized",  subcategories_response.error.status
+    end
+  end
+
+end

data/test/access/city_savings_test.rb

@@ -0,0 +1,5 @@
+require './test/test_helper'
+
+class CitySavingsTest < Minitest::Test
+
+end

data/test/access/filter_test.rb

@@ -0,0 +1,40 @@
+require './test/test_helper'
+
+class FilterTest < Minitest::Test
+
+  def get_first_filter
+    VCR.use_cassette('filter search') do
+      @first_filter = Access::Filter.search(per_page: 1).filters.first
+    end
+  end
+
+  def test_filters_search
+    VCR.use_cassette('filter search') do
+      filters_response = Access::Filter.search(per_page: 1)
+      assert filters_response.success
+      first_filter = filters_response.filters.first
+      assert_kind_of Access::FilterResponse, filters_response
+      assert_kind_of Access::Link, filters_response.links
+      assert_kind_of Access::Info, filters_response.info
+      assert_kind_of Array, filters_response.filters
+      assert_kind_of Access::Filter, first_filter
+      assert first_filter.json_filter
+      assert first_filter.hash_filter
+    end
+  end
+
+  def test_filters_find
+    get_first_filter
+    VCR.use_cassette('filter find') do
+      filters_response = Access::Filter.find(@first_filter.filter_id)
+      assert filters_response.success
+      first_filter = filters_response.filters.first
+      assert_kind_of Access::FilterResponse, filters_response
+      assert_kind_of Array, filters_response.filters
+      assert_kind_of Access::Filter, first_filter
+      assert first_filter.json_filter
+      assert first_filter.hash_filter
+    end
+  end
+
+end