access 1.1.7 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e99cab47666893bfa7332b3460407bf898f3f302
-  data.tar.gz: ba6667849980ea43b32c22a703ce5cac31ddd451
+  metadata.gz: e083e07912e9391f135079ff737459f2d0dcbc3c
+  data.tar.gz: fc453c9ca589f35ac8fdbd36303771892960fe3c
 SHA512:
-  metadata.gz: 54771695dc0e7b16b949379fba7e8f522b5d960b207a72a43c9c98dd21b3f517a33e6254ffdb73d45057c2a7415227f9f09fce9a51237ec097e00d50673bfc61
-  data.tar.gz: 82617f27889ee27520468226ba37bb6d468cae801683f6a543b592c2086547ad23b05821eb9b369e6e910eb044417bbacea31ace018283da1eef7d672bdabe0e
+  metadata.gz: 58137b7e514a16d52e944e16a989dad303d2ec44ddf910211be166a73bd2e5d4bf3daeab509c6ced7b8fa8b41409d63f272a5b0bb9f7f5965d457e1bd20c9213
+  data.tar.gz: 79427cf14e906ba5d800a389f410627dcf5da884090e3e324ea31ac3d22ca0b89e8ed5f024a8dd1ff8b8f51f02eb9430cd2af6ec730e6e3bcf46f2a782ac8035

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-pro

data/.gitignore

@@ -14,3 +14,5 @@
 mkmf.log
 *.sublime-project
 *.sublime-workspace
+
+.DS_Store

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
+  - jruby-19mode
+script: "bundle exec rake test"
+notifications:
+  slack: accessdevelopment:ROQuruk7tsHBNDHZ1kGoXvdl

data/Guardfile

@@ -0,0 +1,7 @@
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/README.md

@@ -7,7 +7,7 @@ A ruby wrapper for the Access API
 ## Installation
 
 ```ruby
-gem 'access'
+  gem 'access', '~> 2.0.0'
 ```
 
 And then execute:
@@ -25,16 +25,15 @@ Or install it yourself as:
 You can configure the following options:
 
   - `access_token` **Required**
-  - `format`: Set as `'json'` or `'xml'`. Default is `'json'`
-  - `api_environment`: Set as `'staging'` or `'production'`. Default is `'staging'`
-  - `api_version`: `'v1'` is default.
-  - `hashify` Returns the results all using Hashie::Mash if `'true'`, Default is `'false'`
+  - `api_environment`: Set as `'demo'` or `'production'`. Default is `'demo'`
+  - `return_json`: Set as `'true'` or `'false'`. Default is `'false'` return ruby objects.
+  - `hashify`: Set as `'true'` or `'false'`. Default is `'false'` return a hashed version of the json response if `return_json` is set to 'true'
 
 #### Config via Environment Variables
 
 You can set config settings by creating environment variables called:
 
-`ENV['ACCESS_TOKEN']`, `ENV['ACCESS_FORMAT']`, `ENV['ACCESS_ENVIRONMENT']`, `ENV['ACCESS_VERSION']`, `ENV['ACCESS_HASHIFY']`
+`ENV['ACCESS_TOKEN']`, `ENV['ACCESS_ENVIRONMENT']`, `ENV['ACCESS_RETURN_JSON']`, `ENV['ACCESS_HASHIFY']`
 
 #### Config via Initializer
 
@@ -43,88 +42,218 @@ You can also create an initializer file to set up a config
 ```ruby
 Access.configure do |config|
   config.access_token = ENV['ACCESS_TOKEN']
-  config.hashify = 'true'
 end
 ```
 
 You can also set them one at a time
 
-`Access.config.format = 'xml'`
+`Access.config.access_token = ENV['ACCESS_TOKEN']`
+
+### Config via Params
+
+`return_json` can be overwritten by passing in by passing the param `return_json` to the end of any call that accepts options.
+
+`hashify` can be overwritten by passing in by passing the param `hashify` to the end of any call that accepts options.
 
 ###Making Calls
 
 ####Offer
 
 ```ruby
-Access::Offer.search options
+Access::Offer.search options, member_key: **your-member-key**
 ```
 
 ```ruby
-Access::Offer.find **offer_key** options, member_key: **your-member-key**
+Access::Offer.find **offer_key**, options, member_key: **your-member-key**
 ```
 
 ####Store
 
 ```ruby
-Access::Store.search options
+Access::Store.search options, member_key: **your-member-key**
 ```
 
 ```ruby
-Access::Store.find store_key options
+Access::Store.find **store_key**, options, member_key: **your-member-key**
+```
+
+```ruby
+Access::Store.national options, member_key: **your-member-key**
 ```
 
 ####Location
 
 ```ruby
-Access::Location.search options
+Access::Location.search options, member_key: **your-member-key**
 ```
 
 ```ruby
-Access::Location.find location_key options
+Access::Location.find **location_key**, options, member_key: **your-member-key**
 ```
 
 ####Category
 
 ```ruby
-Access::Category.search options
+Access::Category.search options, member_key: **your-member-key**
+```
+
+```ruby
+Access::Category.find **category_key**, options, member_key: **your-member-key**
+```
+
+####Autocomplete
+
+```ruby
+Access::Autocomplete.search options
+```
+
+```ruby
+Access::Autocomplete.search_stores options
+```
+
+```ruby
+Access::Autocomplete.search_categories options
+```
+
+```ruby
+Access::Autocomplete.search_offers options
+```
+
+```ruby
+Access::Autocomplete.search_locations options
+```
+
+####Redeem
+
+```ruby
+Access::Redeem.redeem_offer **key**, nil, options, member_key: **your-member-key**
+```
+
+```ruby
+Access::Redeem.redeem_offer **offer_key**, **redeem_type**, options, member_key: **your-member-key**
+```
+
+####Member
+
+####City Savings
+
+```ruby
+Access::CitySavings.search_city_savings options, member_key: **your-member-key**
+```
+
+####Channel
+
+```ruby
+Access::Channel.search options
+```
+
+```ruby
+Access::Channel.find **channel_key**, options
+```
+
+####Campaign
+
+```ruby
+Access::Campaign.search options
 ```
 
 ```ruby
-Access::Category.find key options
+Access::Campaign.find **campaign_key**, options
+```
+
+###Spot
+
+```ruby
+Access::Spot.search_by_channel **channel_key**, options
+```
+
+```ruby
+Access::Spot.search_by_campaign **campaign_key**, options
+```
+
+```ruby
+Access::Spot.find **spot_key**, options
+```
+
+###Internal Admin only Calls
+
+###Filter
+
+```ruby
+Access::Filter.search options
+```
+
+```ruby
+Access::Filter.find **filter_key**, options
 ```
 
 ####Report
 
+```ruby
+Access::Report.all_usage options
+```
+
 ```ruby
 Access::Report.usage options
 ```
 
 ```ruby
-Access::Report.usage token options
+Access::Report.usage_other **token**, options
 ```
 
 ####Token
 
 ```ruby
-Access::Token.verify options
+Access::Token.search options
 ```
 
 ```ruby
-Access::Token.verify_other token options
+Access::Token.find **token**, options
 ```
 
-####Redeem
+####Oauth Application
 
 ```ruby
-Access::Redeem.redeem_offer key nil options` *member_key required
+Access::OauthApplication.search options
 ```
 
 ```ruby
-Access::Redeem.redeem_offer key redeem_type options` *member_key required
+Access::OauthApplication.find **application_id**, options
 ```
 
-####Member
+```ruby
+Access::OauthApplication.search_tokens **application_id**, options
+```
+
+```ruby
+Access::OauthApplication.find_token **application_id**, **token_id**, options
+```
+
+```ruby
+Access::OauthApplication.create_token **application_id**, options
+```
+
+```ruby
+Access::OauthApplication.create **application_id**, options
+```
+
+```ruby
+Access::OauthApplication.update **application_id**, options
+```
+
+```ruby
+Access::OauthApplication.delete **application_id**, options
+```
+
+####Verify
+
+```ruby
+  Access::Verify.token options
+```
 
+```ruby
+  Access::Verify.filter options
+```
 
 ## Contributing
 
@@ -134,5 +263,12 @@ Access::Redeem.redeem_offer key redeem_type options` *member_key required
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+### Running the Tests
+
+`ACCESS_TOKEN=**your-access-token** rake`
+
+`ACCESS_TOKEN=*your-access-token** guard`
 
+### Running the Gem in Console
 
+`ACCESS_TOKEN=*your-access-token** ruby bin/console`

data/Rakefile

@@ -1,2 +1,15 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
 
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test
+
+task :clear_vcr do
+  `rm test/fixtures/*.yml`
+end

data/access.gemspec

@@ -24,7 +24,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "minitest-focus"
 
-  spec.add_dependency "httparty", "~> 0.13.3"
   spec.add_dependency "hashie", "~> 3.3.1"
+  spec.add_dependency "httparty", "~> 0.13.3"
 end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "access"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/access.rb

@@ -2,23 +2,34 @@ require "rubygems"
 require "hashie"
 require "httparty"
 
-require "access/version"
-require "access/error"
 require "access/config"
-require "access/request"
 require "access/api"
-require "access/offer"
-require "access/store"
-require "access/location"
-require "access/category"
 require "access/autocomplete"
-require "access/report"
+require "access/campaign"
+require "access/category"
+require "access/channel"
+require "access/city_savings"
+require "access/error"
 require "access/filter"
+require "access/info"
+require "access/link"
+require "access/location"
+require "access/member"
 require "access/oauth_application"
+require "access/offer"
+require "access/redeem"
+require "access/report"
+require "access/request"
+require "access/response"
+require "access/spot"
+require "access/store"
 require "access/token"
 require "access/verify"
-require "access/redeem"
-# require "access/member"
+require "access/version"
+
+module Access
+
+end
 
 HTTParty::Response.class_eval do
   def hashify

data/lib/access/api.rb

@@ -1,145 +1,269 @@
 module Access
-  class Api < Request
+  class Api
 
     # Categories
     def search_categories(options = {})
-      get("/categories", "offer", options)
+      request.get("/categories", "offer", options) do |response|
+        CategoryResponse.new(response)
+      end
     end
 
-    def find_category(category_id, options = {})
-      get("/categories/#{category_id}", "offer", options)
+    def find_category(category_key, options = {})
+      request.get("/categories/#{category_key}", "offer", options) do |response|
+        CategoryResponse.new(response)
+      end
     end
 
-
     # Offers
-    def search_offers(options={})
-      get("/offers", "offer", options)
+    def search_offers(options = {})
+      request.get("/offers", "offer", options) do |response|
+        OfferResponse.new(response)
+      end
     end
 
-    def find_offer(offer_id, options = {})
-      get("/offers/#{offer_id}", "offer", options)
+    def find_offer(offer_key, options = {})
+      request.get("/offers/#{offer_key}", "offer", options) do |response|
+        OfferResponse.new(response)
+      end
     end
 
-
     # Locations
-    def search_locations(options={})
-      get("/locations", "offer", options)
+    def search_locations(options = {})
+      request.get("/locations", "offer", options) do |response|
+        LocationResponse.new(response)
+      end
     end
 
-    def find_location(location_id, options = {})
-      get("/locations/#{location_id}", "offer", options)
+    def find_location(location_key, options = {})
+      request.get("/locations/#{location_key}", "offer", options) do |response|
+        LocationResponse.new(response)
+      end
     end
 
-
     # Stores
-    def search_stores(options={})
-      get("/stores", "offer", options)
+    def search_stores(options = {})
+      request.get("/stores", "offer", options) do |response|
+        StoreResponse.new(response)
+      end
     end
 
-    def find_store(store_id, options = {})
-      get("/stores/#{store_id}", "offer", options)
+    def find_store(store_key, options = {})
+      request.get("/stores/#{store_key}", "offer", options) do |response|
+        StoreResponse.new(response)
+      end
     end
 
     def national_stores(options={})
-      get("/stores/national", "offer", options)
+      request.get("/stores/national", "offer", options) do |response|
+        StoreResponse.new(response)
+      end
     end
 
-
     # Autocomplete
     def autocomplete(options = {})
-      get("/autocomplete", "offer", options)
+      request.get("/autocomplete", "offer", options) do |response|
+        AutocompleteResponse.new(response)
+      end
     end
 
+    # Redeem
+    def redeem_offer(offer_key, redeem_type = nil, options = {})
+      request.get("/redeem/#{offer_key}/#{redeem_type}", "redeem", options) do |response|
+        RedeemResponse.new(response)
+      end
+    end
 
-    # Filters
-    def search_filters(options = {})
-      get('/filters', 'token', options)
+    # CitySavings
+    def search_city_savings(options = {})
+      # this is broken
+      request.get("/citysavings", "allcitysavings", options) do |response|
+        CitySavingsResponse.new(response)
+      end
+    end
+
+    # Channel
+    def search_channels(options = {})
+      request.get("/channels", "campaign", options) do |response|
+        ChannelResponse.new(response)
+      end
     end
 
-    def find_filter(application_id, options = {})
-      get("/filters/#{application_id}", 'token', options)
+    def find_channel(channel_key, options = {})
+      request.get("/channels/#{channel_key}", "campaign", options) do |response|
+        ChannelResponse.new(response)
+      end
     end
 
+    # Campaign
+    def search_campaigns(options = {})
+      request.get("/campaigns", "campaign", options) do |response|
+        ChampaignResponse.new(response)
+      end
+    end
 
-    # Oauth Applications
-    def search_oauth_applications(options = {})
-      get('/oauth_applications', 'token', options)
+    def find_campaign(campaign_key, options = {})
+      request.get("/campaigns/#{store_key}", "campaign", options) do |response|
+        ChampaignResponse.new(response)
+      end
     end
 
-    def find_oauth_application(application_id, options = {})
-      get("/oauth_applications/#{application_id}", 'token', options)
+    # Spot
+    def search_spots_by_channel(channel_key, options = {})
+      request.get("/spots/channel/#{channel_key}", "campaign", options) do |response|
+        SpotResponse.new(response)
+      end
     end
 
-    def search_oauth_application_tokens(application_id, options = {})
-      get("/oauth_applications/#{application_id}/access_tokens", 'token', options)
+    def search_spots_by_campaign(campaign_key, options = {})
+      request.get("/spots/campaign/#{campaign_key}", "campaign", options) do |response|
+        SpotResponse.new(response)
+      end
     end
 
-    def find_oauth_application_token(application_id, token_id, options = {})
-      get("/oauth_applications/#{application_id}/access_tokens/#{token_id}", 'token', options)
+    def find_spot(spot_key, options = {})
+      request.get("/spots/#{spot_key}", "campaign", options) do |response|
+        SpotResponse.new(response)
+      end
     end
 
-    def create_oauth_application_token(application_id, options = {})
-      create("/oauth_applications/#{application_id}/access_tokens", 'token', options)
+    # Member
+
+    # Internal Admin only Call Below
+
+    # Filters
+    def search_filters(options = {})
+      # Internal Admin only Call
+      request.get("/filters", "token", options) do |response|
+        FilterResponse.new(response)
+      end
     end
 
-    def create_oauth_application(options = {})
-      create("/oauth_applications", 'token', options)
+    def find_filter(application_key, options = {})
+      # Internal Admin only Call
+      request.get("/filters/#{application_key}", "token", options) do |response|
+        FilterResponse.new(response)
+      end
     end
 
-    def update_oauth_application(application_id, options = {})
-      put("/oauth_applications/#{application_id}", 'token', options)
+    # Oauth Applications
+    def search_oauth_applications(options = {})
+      # Internal Admin only Call
+      request.get("/oauth_applications", 'token', options) do |response|
+        OauthApplicationResponse.new(response)
+      end
     end
 
-    def delete_oauth_application(application_id, options = {})
-      delete("/oauth_applications/#{application_id}", 'token', options)
+    def find_oauth_application(application_key, options = {})
+      # Internal Admin only Call
+      request.get("/oauth_applications/#{application_key}", 'token', options) do |response|
+        OauthApplicationResponse.new(response)
+      end
     end
 
+    def search_oauth_application_tokens(application_key, options = {})
+      # Internal Admin only Call
+      request.get("/oauth_applications/#{application_key}/access_tokens", 'token', options) do |response|
+        TokenResponse.new(response)
+      end
+    end
 
-    # Access Tokens
-    def search_tokens(options = {})
-      get('/tokens', 'token', options)
+    def find_oauth_application_token(application_key, token_key, options = {})
+      # Internal Admin only Call
+      request.get("/oauth_applications/#{application_key}/access_tokens/#{token_key}", 'token', options) do |response|
+        TokenResponse.new(response)
+      end
     end
 
-    def find_token(token, options = {}) # new verify_other
-      get("/tokens/#{token}", "token", options)
+    def create_oauth_application_token(application_key, options = {})
+      # Internal Admin only Call
+      request.create("/oauth_applications/#{application_key}/access_tokens", 'token', options) do |response|
+        # TokenResponse.new(response)
+        # OauthApplicationResponse.new(response)
+      end
+      # create("/oauth_applications/#{application_key}/access_tokens", 'token', options)
     end
 
+    def create_oauth_application(options = {})
+      # Internal Admin only Call
+      request.create("/oauth_applications", 'token', options) do |response|
+        OauthApplicationResponse.new(response)
+      end
+      # create("/oauth_applications", 'token', options)
+    end
 
-    # Verify
-    def verify_token(options = {})
-      get('/verify', 'token', options)
+    def update_oauth_application(application_key, batch= {})
+      # Internal Admin only Call
+      request.put("/oauth_applications/#{application_key}", 'token', options) do |response|
+        OauthApplicationResponse.new(response)
+      end
+      # put("/oauth_applications/#{application_key}", 'token', options)
     end
 
-    def verify_filter(options = {})
-      get_json('/filter', 'token', options)
+    def delete_oauth_application(application_key, options = {})
+      # Internal Admin only Call
+      request.delete("/oauth_applications/#{application_key}", 'token', options) do |response|
+        OauthApplication.new(response)
+      end
+      # delete("/oauth_applications/#{application_key}", 'token', options)
     end
 
+    # Access Tokens
+    def search_tokens(options = {})
+      # Internal Admin only Call
+      request.get("/tokens", 'token', options) do |response|
+        TokenResponse.new(response)
+      end
+    end
 
-    # Redeem
-    def redeem_offer(offer_key, redeem_type = nil, options = {})
-      get("/redeem/#{offer_key}/#{redeem_type}", "redeem", options)
+    def find_token(token, options = {})
+      # Internal Admin only Call
+      # new verify_other
+      request.get("/tokens/#{token}", "token", options) do |response|
+        TokenResponse.new(response)
+      end
     end
 
-    def citysavings(options = {})
-      get("/citysavings", "allcitysavings", options)
+    # Verify
+    def verify_token(options = {})
+      # Internal Admin only Call
+      request.get("/verify", 'token', options) do |response|
+        VerifyResponse.new(response)
+      end
     end
 
+    def verify_filter(filter, options = {})
+      # Internal Admin only Call
+      request.get_for_filter("/filter", 'token', filter, options) do |response|
+        VerifyResponse.new(response)
+      end
+    end
 
     # Report
     def all_usage(options = {})
-      get("/all_usage", "report", options)
+      # Internal Admin only Call
+      request.get("/all_usage", "report", options) do |response|
+        ReportResponse.new(response)
+      end
     end
 
     def usage(options = {})
-      get("/usage", "report", options)
+      # Internal Admin only Call
+      request.get("/usage", "report", options) do |response|
+        ReportResponse.new(response)
+      end
     end
 
     def usage_other(token, options = {})
-      get("/usage/#{token}", "report", options)
+      # Internal Admin only Call
+      request.get("/usage/#{token}", "report", options) do |response|
+        ReportResponse.new(response)
+      end
     end
 
+    private
 
-    # Member
-
+    def request
+      Access::Request.new
+    end
   end
 end