groupon 0.0.1 → 1.0.0

data/lib/groupon.rb

@@ -1,40 +1,43 @@
 require 'httparty'
 require 'hashie'
+require 'groupon/client'
 
-directory = File.expand_path(File.dirname(__FILE__))
 
 Hash.send :include, Hashie::HashExtensions
 
 module Groupon
-  
-  VERSION = "0.0.1".freeze
-  
+
+  # Returns a list of divisions - cities where Groupon is live.
+  # @see http://sites.google.com/site/grouponapi/divisions-api  Groupon API docs
+  # @return [Array<Hashie::Mash>] an array of divisions
   def self.divisions
     Groupon::Client.new.divisions
   end
-  
-  def self.deals(options={})
-    Groupon::Client.new.deals(options)
-  end
 
-  # config/initializers/gowalla.rb (for instance)
-  # 
-  # Groupon.configure do |config|
-  #   config.api_key = 'api_key'
-  # end
-  # 
-  # elsewhere
+  # Returns a list of deals.
+  #   The API returns an ordered list of deals currently running for a given Division.
+  #   Priority is based on position within the response (top deals are higher in priority).
+  #
+  # @see http://sites.google.com/site/grouponapi/divisions-api  Groupon API docs
   #
-  # client = Groupon::Client.new
-  def self.configure
-    yield self
-    true
+  # @option options [String] :lat (Latitudinal coordinates based on IP of API request) Latitude of geolocation to find deals
+  # @option options [String] :lng (Longtitudinal coordinates based on IP of API request) Longitude of geolocation to find deals
+  # @return [Array<Hashie::Mash>] an array of deals
+  def self.deals(options={})
+    Groupon::Client.new.deals(options)
   end
 
   class << self
+
+    # Get/sets the required Groupon API token
+    # @see http://sites.google.com/site/grouponapi/home  Groupon API docs
+    #
+    # @param [String]
+    # @return [String]
     attr_accessor :api_key
   end
-  
+
+  # Contains information for errors returned by the API
   class GrouponError < StandardError
     attr_reader :data
 
@@ -45,4 +48,3 @@ module Groupon
   end
 end
 
-require File.join(directory, 'groupon', 'client')

data/lib/groupon/client.rb

@@ -1,38 +1,61 @@
 module Groupon
   class Client
+    attr_accessor :api_key
     include HTTParty
-    base_uri "http://www.groupon.com/api/v1"
+    base_uri "http://api.groupon.com/v2"
     format :json
 
+    # Initialize the Groupon client
+    #
+    # @option options [String] :api_key (Groupon.api_key) Your Groupon API token
+
     def initialize(options={})
-      api_key = options[:api_key] || Groupon.api_key
-      self.class.headers({'X-GrouponToken' => api_key }) unless api_key.nil?
+      @api_key = options[:api_key] || Groupon.api_key
     end
-    
+    # Returns a list of divisions - cities where Groupon is live.
+    # @see http://sites.google.com/site/grouponapi/divisions-api  Groupon API docs
+    #
+    # @return [Array<Hashie::Mash>] an array of divisions
     def divisions
-      self.class.get("/divisions.json").divisions
+      self.class.get("/divisions.json",:query => { :client_id => @api_key }).divisions
     end
-    
+
+    # Returns a list of deals.
+    #
+    #   The API returns an ordered list of deals currently running for a given Division.
+    #
+    #   Priority is based on position within the response (top deals are higher in priority).
+    #
+    #
+    #
+    # @see http://sites.google.com/site/grouponapi/divisions-api Groupon API docs
+    #
+    #
+    #
+    # @option options [String] :lat (Latitudinal coordinates based on IP of API request) Latitude of geolocation to find deals
+    #
+    # @option options [String] :lng (Longtitudinal coordinates based on IP of API request) Longitude of geolocation to find deals
+    #
+    # @return [Array<Hashie::Mash>] an array of deals
     def deals(query={})
       division = query.delete(:division)
+      query.merge! :client_id => @api_key
       path = division ? "/#{division}" : ""
       path += "/deals.json"
       self.class.get(path, :query => query).deals
     end
 
-
     def self.get(*args); handle_response super end
     def self.post(*args); handle_response super end
-    
+
     def self.handle_response(response)
       case response.code
       when 500...600; raise GrouponError.new(Hashie::Mash.new(response).status)
       else; response
       end
-      
+
       Hashie::Mash.new(response)
-      
+
     end
-    
   end
 end

data/lib/groupon/version.rb

@@ -0,0 +1,3 @@
+module Groupon
+  VERSION = "1.0.0"
+end

data/test/groupon_test.rb

@@ -1,26 +1,26 @@
 require 'helper'
 
 class GrouponTest < Test::Unit::TestCase
-  
+
   context "Groupon API" do
 
     should "return a list of divisions - cities where Groupon is live" do
-      stub_get("/divisions.json", "divisions.json")
+      stub_get("/divisions.json?client_id=", "divisions.json")
       divisions = Groupon.divisions
       divisions.size.should == 61
       divisions.last.name.should == 'Wichita'
       divisions.last.location.latitude.should == 37.6922
     end
-    
+
     should "return a list of deals" do
-      stub_get("/deals.json?lat=32.781100000000002&lng=-96.9791", "deals.json")
+      stub_get("/deals.json?lat=32.781100000000002&lng=-96.9791&client_id=", "deals.json")
       deals = Groupon.deals(:lat => "32.781100000000002", :lng => "-96.9791")
       deals.size.should == 1
       deals.first.discount_percent.should == 50
     end
-    
+
     should "return a list of deals for a specified division" do
-      stub_get("/dallas/deals.json", "deals.json")
+      stub_get("/dallas/deals.json?client_id=", "deals.json")
       deals = Groupon.deals(:division => :dallas)
       deals.size.should == 1
       deals.first.discount_percent.should == 50

data/test/helper.rb

@@ -2,7 +2,6 @@ require 'rubygems'
 require 'test/unit'
 require 'shoulda'
 
-require 'redgreen'
 require 'matchy'
 require 'fakeweb'
 
@@ -25,7 +24,7 @@ def fixture_file(filename)
 end
 
 def groupon_url(url, options={})
-  url =~ /^http/ ? url : "http://www.groupon.com/api/v1#{url}"
+  url =~ /^http/ ? url : "http://api.groupon.com/v2#{url}"
 end
 
 def stub_request(method, url, filename, status=nil)

metadata

@@ -1,147 +1,180 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: groupon
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Wynn Netherland
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-23 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        - 3
-        version: 0.1.3
+date: 2010-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
   prerelease: false
-  requirement: *id001
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        - 0
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.1.0
-  name: httparty
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.1
+  type: :development
   prerelease: false
-  requirement: *id002
-  type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 10
-        - 1
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.10.1
-  name: shoulda
+- !ruby/object:Gem::Dependency
+  name: mg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :development
   prerelease: false
-  requirement: *id003
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: redgreen
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 4
-        - 0
-        version: 0.4.0
-  name: matchy
   prerelease: false
-  requirement: *id004
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jnunemaker-matchy
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
   type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 5
-        version: 1.2.5
-  name: fakeweb
   prerelease: false
-  requirement: *id005
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.5
   type: :development
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  name: yard
   prerelease: false
-  requirement: *id006
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Wrapper for the Groupon API
 email: wynn.netherland@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/groupon/client.rb
+- lib/groupon/version.rb
 - lib/groupon.rb
-has_rdoc: true
+- test/helper.rb
+- test/groupon_test.rb
 homepage: http://github.com/pengwynn/groupon
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Wrapper for the Groupon API
-test_files: 
+test_files:
 - test/helper.rb
 - test/groupon_test.rb
+has_rdoc: