groupon_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36abbb1658aa07d35134e1f59fa33d6a87aed2b2
+  data.tar.gz: be136abc6dd392f36a7de3692bab249a860767af
+SHA512:
+  metadata.gz: 33be32dd150a0511157b3eb839442b149fe8fb684ddceebd6dd2beafab96ea1df20f242e1e32772e8909717e99e45cf600934d9eff69f2f6301e0e42126c43b8
+  data.tar.gz: 6aafe81ad1e0b42f0c1d35c3a4ca0edbdedb886da4ee18fde8b074eac243371365f22eab4e83c232ea0c1f8e0932f6a57a7c6feb7b0e4230eacf265770148d62

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Bryan Liff
+
+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,71 @@
+# GrouponApi
+
+Groupon API gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'groupon_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install groupon_api
+
+## Usage
+
+### Authorization
+
+You must have an active partner account to use this gem.
+
+Apply here: https://partner.groupon.com
+
+### Configuration
+
+For most method calls GrouponApi must be configured with your partner tsToken, which you can set as such:
+
+	GrouponApi.configure do |config|
+	  config.ts_token = 'US_AFF_0_201236_212556_0'
+	end
+
+Additionally you can set default params per API call
+
+	GrouponApi.configure do |config|
+	  config.deals = {show: 'name,lat,lng', hide: 'areas,timezone,timezoneOffsetInSeconds'}
+	end
+	
+Ad hoc configuration can be done with the ```.config``` method:
+
+	GrouponApi.config.use_ssl = true #default, will use https instead of http
+	
+### Deals
+Find Groupon deals with the ```.deals``` method.
+
+	deals = GrouponApi.deals(params)
+	deals[0] #HashWithIndifferentAccess
+	
+Your ```:ts_token``` will be automatically applied as well as any other default params set in ```config.deals```
+	
+A full list of parameters may be found here: https://partner-api.groupon.com/help/deal-api
+
+## Testing
+
+Since Groupon does not provide a test API enpoint / account, you must use your partner account
+for testing.
+
+Simply change the return value of ```#your_ts_token``` in ```spec/spec_helper.rb```
+
+## Contributing
+
+1. Fork it ( https://github.com/minerva-group/groupon_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add needed specs & code implementation
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

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

data/lib/groupon_api.rb

@@ -0,0 +1,9 @@
+require "groupon_api/version"
+require 'groupon_api/config'
+require "groupon_api/deals"
+require "groupon_api/request"
+
+module GrouponApi
+  API_KEY_FORMAT = /US_AFF_0_\d+_212556_0/
+  API_BASE = 'partner-api.groupon.com'
+end

data/lib/groupon_api/config.rb

@@ -0,0 +1,26 @@
+require 'active_support/configurable'
+
+module GrouponApi
+  # configure GrouponApi global settings
+  #   GrouponApi.configure do |config|
+  #     config.ts_token = 'US_AFF_0_201236_212556_0'
+  #   end
+  def self.configure &block
+    yield @config ||= GrouponApi::Configuration.new
+  end
+
+  # GrouponApi global settings
+  def self.config
+    @config ||= GrouponApi::Configuration.new
+  end
+
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor(:ts_token){ nil }
+    config_accessor(:use_ssl){ true }
+    
+    #deals
+    config_accessor(:deals){ {} }
+  end
+end

data/lib/groupon_api/deals.rb

@@ -0,0 +1,11 @@
+module GrouponApi
+  def self.deals(params)
+    raise ::ArgumentError, 'param :ts_token cannot be nil' if GrouponApi.config.ts_token.nil?
+    raise ::ArgumentError, 'param :ts_token must match /US_AFF_0_\d+_212556_0/' unless GrouponApi.config.ts_token.match(API_KEY_FORMAT)
+    
+    params.merge!(GrouponApi.config.deals)
+    params.merge!(tsToken: GrouponApi.config.ts_token)
+    
+    GrouponApi::Request.call('deals', params)
+  end
+end

data/lib/groupon_api/request.rb

@@ -0,0 +1,30 @@
+require "net/http"
+require "uri"
+require 'json'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module GrouponApi
+  class Request
+    def self.call(endpoint, params)
+      # format query string
+      query_arr = []
+      params.each_pair do |key,val|
+        query_arr << "#{key}=#{val}"
+      end
+      
+      # Call API with config.use_ssl
+      protocol = GrouponApi.config.use_ssl ? 'https' : 'http'
+      url_str = "#{protocol}://#{API_BASE}/#{endpoint}.json?#{query_arr.join('&')}"
+      begin
+        result = Net::HTTP.get(URI.parse(url_str))
+      rescue => e
+        puts '[RESCUE]: ' + e.to_s
+        return []
+      end
+      
+      # return result as Array of HashWithIndifferentAccess
+      json = JSON.parse(result)
+      json['deals'].collect{|deal| HashWithIndifferentAccess.new(deal)}
+    end
+  end
+end

data/lib/groupon_api/version.rb

@@ -0,0 +1,3 @@
+module GrouponApi
+  VERSION = "0.1.0"
+end

data/spec/groupon_api_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe GrouponApi do
+  
+  shared_context :without_api_key do
+    before do
+      GrouponApi.config.ts_token = nil
+    end
+  end
+  shared_context :invalid_api_key do
+    before do
+      GrouponApi.config.ts_token = 42
+    end
+  end
+  shared_context :valid_api_key do
+    before do
+      GrouponApi.config.ts_token = your_ts_token
+    end
+  end
+  
+  describe '.deals' do
+    let(:valid_params){
+      {
+        lat: 40.704235,
+        lng: -73.986797,
+        radius: 10
+      }
+    }
+    context 'without API key' do
+      include_context :without_api_key
+      it "throws an exception" do
+        expect{described_class.deals(valid_params)}.to raise_error(ArgumentError, 'param :ts_token cannot be nil')
+      end
+    end
+    context 'with invalid API key' do
+      include_context :invalid_api_key
+      it 'throws an exception' do
+        expect{described_class.deals(valid_params)}.to raise_error
+      end
+    end
+    context 'with valid API key' do
+      include_context :valid_api_key
+      context 'without results' do
+        it 'returns an empty Array' do
+          params = valid_params.merge(limit: 0, offset: 0)
+          result = described_class.deals(params)
+          expect(result).to be_a(Array)
+          expect(result.size).to eq(0)
+        end  
+      end
+      context 'with results' do  
+        it "returns an Array of Hashes" do
+          result = described_class.deals(valid_params)
+          expect(result).to be_a(Array)
+          expect(result.first).to be_a(HashWithIndifferentAccess)
+        end
+      end
+    end    
+  end #deals
+  
+  describe '.divisions' do
+    pending
+  end #divisions
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'groupon_api' # and any other gems you need
+
+def your_ts_token
+  ''
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: groupon_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryan Liff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Provides a Ruby gem wrapper for the Groupon API
+email:
+- bliff@minerva-group.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/groupon_api.rb
+- lib/groupon_api/config.rb
+- lib/groupon_api/deals.rb
+- lib/groupon_api/request.rb
+- lib/groupon_api/version.rb
+- spec/groupon_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/minerva-group/groupon_api
+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.6
+signing_key: 
+specification_version: 4
+summary: Groupon API gem
+test_files:
+- spec/groupon_api_spec.rb
+- spec/spec_helper.rb