access 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae88dc0242b7774cc1ff3b22b877a0b68147dc4f
+  data.tar.gz: 39b05913c4dd0cff112e77f47ec5bf7525e09098
+SHA512:
+  metadata.gz: 2e216748c7697762c007f023c638afe459f4d6510811dc0b5d903b114a331032812f31dce4e3a5e95dfc659114bb54a6bdc2a31fa1f40c2550342ae02c614d65
+  data.tar.gz: 54b0590f1b016fb7254f24aedef1610259e24b7c283298610c07a0debaf5df52e2f4d0dd3423a531d57eb8cdfaa4e024ccfa3c7516aa5279f2d21d80a0de2c6e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+api-ruby

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in access.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Eggett
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+[![Build Status](https://magnum.travis-ci.com/access-development/api-ruby.svg?token=T9pynazhFyqzCqj2LUNj&branch=master)](https://magnum.travis-ci.com/access-development/api-ruby) [![Code Climate](https://codeclimate.com/repos/5466a5ce69568076f20003de/badges/9bf8e7713208de5ce932/gpa.svg)](https://codeclimate.com/repos/5466a5ce69568076f20003de/feed)
+
+# Access API
+
+A ruby wrapper for the Access API
+
+## Installation
+
+```ruby
+gem 'access', path: '../api-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install access
+
+## Setup
+
+###Config setup
+
+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"
+
+You can set these buy creating environment variables called:
+
+`ENV['ACCESS_TOKEN']`, `ENV['ACCESS_FORMAT']`, `ENV['ACCESS_ENVIRONMENT']`, `ENV['ACCESS_VERSION']`, `ENV['ACCESS_HASHIFY']`
+
+or create an initializer file and set your config
+
+```
+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`
+
+###Making Calls
+
+####Offer
+
+  `Access::Offer.search options`
+  `Access::Offer.find offer_key options` *member_key required*
+
+####Store
+
+  `Access::Store.search options`
+  `Access::Store.find store_key options`
+
+####Location
+
+  `Access::Location.search options`
+  `Access::Location.find location_key options`
+
+####Category
+
+  `Access::Category.search options`
+  `Access::Category.find key options`
+
+####Report
+
+  `Access::Report.usage options`
+  `Access::Report.usage token options`
+
+####Token
+
+  `Access::Token.verify options`
+  `Access::Token.verify_other token options`
+
+####Redeem
+
+  `Access::Redeem.redeem_offer key nil options` *member_key required*
+  `Access::Redeem.redeem_offer key redeem_type options` *member_key required*
+
+####Member
+
+
+## Contributing
+
+1. Fork it ( https://github.com/access-development/api-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/access.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'access/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "access"
+  spec.version       = Access::VERSION
+  spec.authors       = ["Ben Eggett"]
+  spec.email         = ["beneggett@gmail.com"]
+  spec.summary       = %q{Ruby wrapper for Access API}
+  spec.description   = %q{Ruby wrapper for Access API}
+  spec.homepage      = "http://www.github.com/access-development/api-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "httparty", "~> 0.8.0"
+  spec.add_dependency "hashie", "~> 2.0"
+end

data/lib/access.rb

@@ -0,0 +1,23 @@
+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/report"
+require "access/token"
+require "access/redeem"
+# require "access/member"
+
+HTTParty::Response.class_eval do
+  def hashify
+    Hashie::Mash.new self
+  end
+end

data/lib/access/api.rb

@@ -0,0 +1,63 @@
+module Access
+  class Api < Request
+
+  ###offer
+    def search_categories(options = {})
+      get("/categories", "offer", options)
+    end
+
+    def find_category(category_id, options = {})
+      get("/categories/#{category_id}", "offer", options)
+    end
+
+    def search_offers(options={})
+      get("/offers", "offer", options)
+    end
+
+    def find_offer(offer_id, options = {})
+      get("/offers/#{offer_id}", "offer", options)
+    end
+
+    def search_locations(options={})
+      get("/locations", "offer", options)
+    end
+
+    def find_location(location_id, options = {})
+      get("/locations/#{location_id}", "offer", options)
+    end
+
+    def search_stores(options={})
+      get("/stores", "offer", options)
+    end
+
+    def find_store(store_id, options = {})
+      get("/stores/#{store_id}", "offer", options)
+    end
+
+  ###token
+    def verify(options = {})
+      get("/verify", "token", options)
+    end
+
+    def verify_other(token, options = {})
+      get("/verify/#{token}", "token", options)
+    end
+
+  ###redeem
+    def redeem_offer(offer_key, redeem_type = nil, options = {})
+      get("/redeem/#{offer_key}/#{redeem_type}", "redeem", options)
+    end
+
+  ###report
+    def usage(options = {})
+      get("/usage", "report", options)
+    end
+
+    def usage_other(token, options = {})
+      get("/usage/#{token}", "report", options)
+    end
+
+  ###member
+
+  end
+end

data/lib/access/category.rb

@@ -0,0 +1,11 @@
+module Access
+  class Category
+    def self.search(options = {})
+      Access::Api.new.search_categories options
+    end
+
+    def self.find(key, options = {})
+      Access::Api.new.find_category key, options
+    end
+  end
+end

data/lib/access/config.rb

@@ -0,0 +1,35 @@
+module Access
+  class << self
+    attr_accessor :config
+  end
+
+  def self.config
+    @config && @config.access_token ? @config : @config = Config.new
+  end
+
+  # Set options via block
+  def self.configure
+    yield(config) if block_given?
+  end
+
+  class Config
+    attr_accessor :access_token, :format, :api_environment, :api_version, :hashify
+
+    def initialize
+      @access_token = ENV['ACCESS_TOKEN']
+      @format = ENV['ACCESS_FORMAT'] || 'json'
+      @api_environment = ENV['ACCESS_ENVIRONMENT'] || 'staging'
+      @api_version = ENV['ACCESS_VERSION'] || 'v1'
+      @hashify = ENV['ACCESS_HASHIFY'] || 'false'
+    end
+
+    def reset
+      self.access_token = ENV['ACCESS_TOKEN']
+      self.format  = 'json'
+      self.api_environment = 'staging'
+      self.api_version = 'v1'
+      self.hashify = false
+    end
+  end
+end
+

data/lib/access/location.rb

@@ -0,0 +1,11 @@
+module Access
+  class Location
+    def self.search(options = {})
+      Access::Api.new.search_locations options
+    end
+
+    def self.find(key, options = {})
+      Access::Api.new.find_location key, options
+    end
+  end
+end

data/lib/access/member.rb

@@ -0,0 +1,5 @@
+module Access
+  class Member
+
+  end
+end

data/lib/access/offer.rb

@@ -0,0 +1,11 @@
+module Access
+  class Offer
+    def self.search(options = {})
+      Access::Api.new.search_offers options
+    end
+
+    def self.find(key, options = {})
+      Access::Api.new.find_offer key, options
+    end
+  end
+end

data/lib/access/redeem.rb

@@ -0,0 +1,7 @@
+module Access
+  class Redeem
+    def self.redeem_offer(key, redeem_type = nil, options = {})
+      Access::Api.new.redeem_offer key, redeem_type, options
+    end
+  end
+end

data/lib/access/report.rb

@@ -0,0 +1,11 @@
+module Access
+  class Report
+    def self.usage(options = {})
+      Access::Api.new.usage options
+    end
+
+    def self.usage_other(key, options = {})
+      Access::Api.new.usage_other key, options
+    end
+  end
+end

data/lib/access/request.rb

@@ -0,0 +1,30 @@
+module Access
+  class Request
+    include HTTParty
+
+    def get(path, api_type, options={})
+      set_format
+      results = self.class.get(set_base(api_type) + path, headers: headers, query: options)
+       Access.config.hashify == "true" ? results.hashify : results
+    end
+
+    private
+
+    def set_base(api_type)
+      if Access.config.api_environment == 'production'
+        "https://#{api_type}.adcrws.com/#{Access.config.api_version}"
+      else
+        "https://#{api_type}-demo.adcrws.com/#{Access.config.api_version}"
+      end
+    end
+
+    def set_format
+      self.class.format Access.config.format.to_sym
+    end
+
+    def headers
+      {"Access-Token" => Access.config.access_token}
+    end
+
+  end
+end

data/lib/access/store.rb

@@ -0,0 +1,11 @@
+module Access
+  class Store
+    def self.search(options = {})
+      Access::Api.new.search_stores options
+    end
+
+    def self.find(key, options = {})
+      Access::Api.new.find_store key, options
+    end
+  end
+end

data/lib/access/token.rb

@@ -0,0 +1,11 @@
+module Access
+  class Token
+    def self.verify(options = {})
+      Access::Api.new.verify options
+    end
+
+    def self.verify_other(token, options = {})
+      Access::Api.new.verify_other token, options
+    end
+  end
+end

data/lib/access/version.rb

@@ -0,0 +1,4 @@
+module Access
+  VERSION = "1.0.0"
+end
+

data/test/offers/offer_test.rb

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

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require './lib/access'
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = "test/fixtures"
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: access
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ben Eggett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Ruby wrapper for Access API
+email:
+- beneggett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- access.gemspec
+- lib/access.rb
+- lib/access/api.rb
+- lib/access/category.rb
+- lib/access/config.rb
+- lib/access/location.rb
+- lib/access/member.rb
+- lib/access/offer.rb
+- lib/access/redeem.rb
+- lib/access/report.rb
+- lib/access/request.rb
+- lib/access/store.rb
+- lib/access/token.rb
+- lib/access/version.rb
+- test/offers/offer_test.rb
+- test/test_helper.rb
+homepage: http://www.github.com/access-development/api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Access API
+test_files:
+- test/offers/offer_test.rb
+- test/test_helper.rb