hitfox_coupon_api 0.0.2 → 0.0.6

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.8.7

data/Gemfile

@@ -9,8 +9,8 @@ group :development do
   gem 'pry'
   gem 'pry-doc'
   gem 'gist'
-  gem "thoughtbot-shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
+  gem "shoulda"
+  gem "bundler"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
   gem 'rr'

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.6

data/hitfox_coupon_api.gemspec

@@ -4,21 +4,23 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "hitfox_coupon_api"
-  s.version = "0.0.2"
+  s.name = %q{hitfox_coupon_api}
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gerrit Riessen"]
-  s.date = "2011-09-01"
-  s.description = "Simple JSON interface to the HitFox coupon API"
-  s.email = "gerrit.riessen@gmail.com"
+  s.date = %q{2012-05-02}
+  s.description = %q{Simple JSON interface to the HitFox coupon API}
+  s.email = %q{gerrit.riessen@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
   ]
   s.files = [
     ".document",
+    ".keep",
     ".rvmrc",
+    ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
     "README.rdoc",
@@ -27,18 +29,24 @@ Gem::Specification.new do |s|
     "hitfox_coupon_api.gemspec",
     "lib/hitfox_coupon_api.rb",
     "lib/hitfox_coupon_api/application.rb",
+    "lib/hitfox_coupon_api/client.rb",
     "lib/hitfox_coupon_api/configuration.rb",
     "lib/hitfox_coupon_api/coupon.rb",
+    "lib/hitfox_coupon_api/order.rb",
+    "lib/hitfox_coupon_api/user.rb",
     "test/.login.yml.sample",
     "test/helper.rb",
+    "test/test_coupon.rb",
     "test/test_hitfox_coupon_api.rb",
+    "test/test_order.rb",
+    "test/test_user.rb",
     "test_shell"
   ]
-  s.homepage = "https://github.com/gorenje/hitfox_coupon_api"
+  s.homepage = %q{https://github.com/gorenje/hitfox_coupon_api}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
-  s.summary = "Simple JSON interface to the HitFox coupon API"
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Simple JSON interface to the HitFox coupon API}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
@@ -50,8 +58,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<pry>, [">= 0"])
       s.add_development_dependency(%q<pry-doc>, [">= 0"])
       s.add_development_dependency(%q<gist>, [">= 0"])
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<rr>, [">= 0"])
@@ -63,8 +71,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<pry>, [">= 0"])
       s.add_dependency(%q<pry-doc>, [">= 0"])
       s.add_dependency(%q<gist>, [">= 0"])
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<rr>, [">= 0"])
@@ -77,8 +85,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<pry>, [">= 0"])
     s.add_dependency(%q<pry-doc>, [">= 0"])
     s.add_dependency(%q<gist>, [">= 0"])
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<rr>, [">= 0"])

data/lib/hitfox_coupon_api/application.rb

@@ -9,5 +9,42 @@ module HitfoxCouponApi
     def coupon(code)
       Coupon.new(self, code)
     end
+
+    def user(user_id)
+      User.new(self, user_id)
+    end
+
+    def order(order_id)
+      Order.new(self, order_id)
+    end
+
+    # return the true/false if count coupons are available for the application
+    def available?(count = 1)
+      Coupon.new(self,nil).available?(count)
+    end
+
+    # take an array of coupon details and create deal coupons. The array is assumed to be
+    # structured as: [type, code, type, code, link, type, code, type, code, ... etc]
+    # where type is one of: :actlink (2 args), :ingame (1 arg), :url (1 arg), e.g.
+    #    [:actlink, code, link, :ingame, code, :url, link, :ingame, code, ....]
+    # would a valid array.
+    def add_coupons(cpns_code)
+      Coupon.new(self,nil).add(cpns_code)
+    end
+    def add_coupons!(cpns_code)
+      Coupon.new(self,nil).add!(cpns_code)
+    end
+
+    # Allow an application to have a specific configuration. This allows
+    # one company to manage multiple products.
+    def configuration
+      @configuration
+    end
+
+    def configure
+      @configuration ||= HitfoxCouponApi.configuration.dup
+      block_given? ? yield(@configuration) : @configuration
+      @configuration
+    end
   end
 end

data/lib/hitfox_coupon_api/client.rb

@@ -0,0 +1,32 @@
+module HitfoxCouponApi
+  class Client
+    HitfoxApiException = Class.new(RuntimeError)
+
+    def configuration
+      @application.configuration || HitfoxCouponApi.configuration
+    end
+
+    def apiheaders
+      config = configuration
+      {
+        "X-API-TOKEN"     => config.api_token,
+        "X-API-APP-ID"    => @application.identifier,
+        "X-API-TIMESTAMP" => config.generate_timestamp,
+      }
+    end
+
+    def generate_url(path, params)
+      '%s%s' % [configuration.api_endpoint, path % params.map { |a| CGI.escape(a) }]
+    end
+
+    def handle_coupon_results(res)
+      if res["status"] == 0
+        res["coupons"].map { |c| c[c.keys.first] }.map do |cc|
+          block_given? ? yield(cc) : Coupon.new(@application, cc["code"], cc["download_url"])
+        end
+      else
+        raise HitfoxApiException, "#{res['status']}: #{res['msg']}"
+      end
+    end
+  end
+end

data/lib/hitfox_coupon_api/coupon.rb

@@ -3,28 +3,90 @@ require 'digest/sha1'
 require 'json'
 
 module HitfoxCouponApi
-  class Coupon
-    def initialize(product, code)
-      @application, @code = product, code
+  class Coupon < Client
+    attr_accessor :code, :url, :state
+
+    def initialize(application, code, url = nil)
+      @application, @code, @url = application, code, url
+    end
+
+    # Add new coupon codes to an application.
+    # Take an array of coupon details and create deal coupons. The array is assumed to be
+    # structured as: [type, code, type, code, link, type, code, type, code, ... etc]
+    # where type is one of: :actlink (2 args), :ingame (1 arg), :url (1 arg), e.g.
+    #    [:actlink, code, link, :ingame, code, :url, link, :ingame, code, ....]
+    # would a valid array.
+    # The :actlink type takes two further parameters: link and code, while the ingame and
+    # url types only take one further argument.
+    def add(cpns_code)
+      headers, params = build_request_data(cpns_code.count) do |config, headers, hshstr|
+        [config.api_version.to_s, Digest::SHA1.hexdigest(hshstr)]
+      end
+      urlstr = generate_url('/%s/coupons/create.json?hash=%s', params)
+      JSON.parse(RestClient.post(urlstr, { :coupons => cpns_code }, headers))
+    end
+
+    def add!(cpns_code)
+      res = add(cpns_code)
+      res["status"] == 0 ? true : raise(HitfoxApiException, "#{res['status']}: #{res['msg']}")
     end
 
+
+    # Make a coupon as having been used by the end-user. This should be called once
+    # the user has entered and reclaimed their coupon. It provides HitFox with the information
+    # that the coupon has been used.
     def used
-      config    = HitfoxCouponApi.configuration
-      timestamp = config.generate_timestamp
-      headers   = {
-        "X-API-TOKEN"     => config.api_token,
-        "X-API-APP-ID"    => @application.identifier,
-        "X-API-TIMESTAMP" => timestamp,
-      }
-
-      str = [ @code, config.api_token, timestamp, @application.identifier,
-              config.api_secret ].join(",")
-
-      path = "/%s/coupon/%s/used.json?hash=%s" % [CGI.escape(config.api_version.to_s),
-                                                  CGI.escape(@code),
-                                                  CGI.escape(Digest::SHA1.hexdigest(str))]
-
-      JSON.parse(RestClient.get("%s%s" % [config.api_endpoint, path], headers))
+      headers, params = build_request_data(@code) do |config, headers, hshstr|
+        [config.api_version.to_s, @code, Digest::SHA1.hexdigest(hshstr)]
+      end
+      urlstr = generate_url('/%s/coupon/%s/used.json?hash=%s', params)
+      JSON.parse(RestClient.get(urlstr, headers))
+    end
+
+    def used!
+      res = used
+      res["status"] == 0 ? true : raise(HitfoxApiException, "#{res['status']}: #{res['msg']}")
+    end
+
+    # Provide details on this coupon. The code, download url and the status are provided
+    # of the coupon.
+    def info
+      headers, params = build_request_data(@code) do |config, headers, hshstr|
+        [config.api_version.to_s, @code, Digest::SHA1.hexdigest(hshstr)]
+      end
+
+      urlstr = generate_url('/%s/coupon/%s/info.json?hash=%s', params)
+
+      handle_coupon_results(JSON.parse(RestClient.get(urlstr, headers))) do |cpn|
+        Coupon.new(Application.new(cpn["app_id"]), cpn["code"], cpn["download_url"]).tap do |cc|
+          cc.state = cpn["state"]
+        end
+      end
+    end
+
+    # Are there count-number of coupons avaiable for this product. This is not strictly
+    # related to a particular coupon, rather this is delegated down from the application
+    # to the coupon, Application#available? should be used instead of this method
+    # directly.
+    def available?(count = 1)
+      headers, params = build_request_data(count) do |config, headers, hshstr|
+        [config.api_version.to_s, Digest::SHA1.hexdigest(hshstr), count.to_s]
+      end
+      urlstr = generate_url('/%s/coupons/available.json?hash=%s&count=%s', params)
+      JSON.parse(RestClient.get(urlstr, headers))["status"] == 0
+    end
+
+    def app_id
+      @application.identifier
+    end
+
+    protected
+
+    def build_request_data(hsh_param, &block)
+      config, headers = configuration, apiheaders
+      hshstr = [ hsh_param, config.api_token, headers["X-API-TIMESTAMP"],
+                 @application.identifier, config.api_secret ].join(",")
+      [headers, yield(config, headers, hshstr)]
     end
   end
 end

data/lib/hitfox_coupon_api/order.rb

@@ -0,0 +1,47 @@
+module HitfoxCouponApi
+  class Order < Client
+    attr_accessor :order_id
+
+    def initialize(application, order_id)
+      @application, @order_id = application, order_id
+    end
+
+    # Reserve count coupons for an order. These are reserved for a specific application,
+    # if an order contains multiple products/deals/applications, then this needs to called
+    # once for each.
+    def reserve(count = 1)
+      headers, params = build_request_data
+      urlstr = generate_url('/%s/coupon/%s/reserve.json?hash=%s&count=%s', params + [count.to_s])
+      handle_coupon_results(JSON.parse(RestClient.get(urlstr, headers)))
+    end
+
+    # Make as paid the coupons attached to the order. Once again, this is related only to
+    # those coupons that are from this application. If an order contains coupons from an
+    # application, then they need to be marked paid separately.
+    def paid
+      headers, params = build_request_data
+      urlstr = generate_url('/%s/coupon/%s/paid.json?hash=%s', params)
+      handle_coupon_results(JSON.parse(RestClient.get(urlstr, headers)))
+    end
+
+    # Return a list of coupons of this order. Once again, this will only provide a list of
+    # coupons that are attached to this application.
+    def coupons
+      headers, params = build_request_data
+      urlstr = generate_url('/%s/coupon/%s/list.json?hash=%s', params)
+      handle_coupon_results(JSON.parse(RestClient.get(urlstr, headers)))
+    end
+
+    protected
+
+    def build_request_data
+      config, headers = configuration, apiheaders
+
+      hshstr = [@order_id, config.api_token, headers["X-API-TIMESTAMP"],
+                @application.identifier, config.api_secret].join(",")
+
+      params = [config.api_version.to_s, @order_id, Digest::SHA1.hexdigest(hshstr)]
+      [headers, params]
+    end
+  end
+end

data/lib/hitfox_coupon_api/user.rb

@@ -0,0 +1,37 @@
+module HitfoxCouponApi
+  class User < Client
+    attr_accessor :user_id
+
+    def initialize(application, user_id)
+      @application, @user_id = application, user_id
+    end
+
+    # buy count coupons for this application. If there aren't enough coupons, then this
+    # will return an empty list. This is an all-or-nothing call, if count coupons aren't
+    # available, then none are bought.
+    def buy_coupon(count = 1)
+      headers, params = build_request_data
+      urlstr = generate_url('/%s/coupon/%s/buy.json?hash=%s&count=%s', params + [count.to_s])
+      handle_coupon_results(JSON.parse(RestClient.get(urlstr, headers)))
+    end
+
+    # Get a list coupons for this user, for this application.
+    def coupons
+      headers, params = build_request_data
+      urlstr = generate_url('/%s/coupon/%s/show.json?hash=%s', params)
+      handle_coupon_results(JSON.parse(RestClient.get(urlstr, headers)))
+    end
+
+    protected
+
+    def build_request_data
+      config, headers = configuration, apiheaders
+
+      hshstr = [@user_id, config.api_token, headers["X-API-TIMESTAMP"],
+                @application.identifier, config.api_secret].join(",")
+
+      params = [config.api_version.to_s, @user_id, Digest::SHA1.hexdigest(hshstr)]
+      [headers, params]
+    end
+  end
+end

data/lib/hitfox_coupon_api.rb

@@ -1,8 +1,11 @@
 require 'rest-client'
 
 require 'hitfox_coupon_api/configuration'
+require 'hitfox_coupon_api/client'
 require 'hitfox_coupon_api/application'
 require 'hitfox_coupon_api/coupon'
+require 'hitfox_coupon_api/order'
+require 'hitfox_coupon_api/user'
 
 module HitfoxCouponApi
   extend self

data/test/helper.rb

@@ -19,4 +19,26 @@ require 'hitfox_coupon_api'
 
 class Test::Unit::TestCase
   include RR::Adapters::TestUnit
+
+  def setup_api_and_header
+    HitfoxCouponApi.configure do |c|
+      c.api_token    = "1234"
+      c.api_secret   = "2143abce"
+      c.api_version  = "one"
+      c.api_endpoint = "http://banana.com"
+    end
+
+    @header = {
+      "X-API-APP-ID"    => "productidentiefer",
+      "X-API-TIMESTAMP" => "1314792296",
+      "X-API-TOKEN"     => "1234"
+    }
+  end
+
+  def mock_rest_client(jsonstr = nil)
+    jsonstr ||= '{ "status" : 1, "msg" : "no message" }'
+    mock.instance_of(HitfoxCouponApi::Configuration).
+      generate_timestamp { '1314792296' }
+    mock(RestClient).get(@url,@header) { jsonstr }
+  end
 end

data/test/test_coupon.rb

@@ -0,0 +1,214 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TestCoupon < Test::Unit::TestCase
+  context "coupon funcationality" do
+    setup do
+      setup_api_and_header
+      @app = HitfoxCouponApi::Application.new("productidentiefer")
+    end
+
+    context "coupon available" do
+      setup do
+        @url = ("http://banana.com/one/coupons/available.json?"+
+                "hash=dfb33057c8670f2f088bf5d12ea30a00955cdfa8&count=1")
+      end
+
+      should "fail if status non zero" do
+        mock_rest_client
+        assert !@app.available?(1)
+      end
+
+      should "fail if status non existent" do
+        mock_rest_client('{}')
+        assert !@app.available?(1)
+      end
+
+      should "succeed if status is zero" do
+        mock_rest_client('{"status" : 0}')
+        assert @app.available?(1)
+      end
+    end
+
+    context "coupon reservation for order" do
+      setup do
+        @url = ("http://banana.com/one/coupon/1231/reserve.json?"+
+                "hash=09b0150d9aeabb6d61427864f0c637051e69cf40&count=1")
+      end
+
+      should "fail if status non-zero" do
+        mock_rest_client
+        assert_raise HitfoxCouponApi::Client::HitfoxApiException do
+          @app.order("1231").reserve
+        end
+      end
+
+      should "generate coupons if all is well" do
+        jsonstr = {
+          :status => 0,
+          :coupons => [{"in_game_coupon" => {
+                         :code => 'fubar',
+                         :download_url => "http://example.com?dd"
+                       }},
+                       {"fubar" => {
+                         :code => 'snafu',
+                         :download_url => "http://example.com?dd/snahf"
+                       }}]}.to_json
+        mock_rest_client(jsonstr)
+
+        cpns = @app.order("1231").reserve
+        assert_equal 2, cpns.count
+        assert_equal "fubar", cpns.first.code
+        assert_equal "http://example.com?dd", cpns.first.url
+        assert_equal "snafu", cpns.last.code
+        assert_equal "http://example.com?dd/snahf", cpns.last.url
+      end
+    end
+
+    context "coupon info" do
+      setup do
+        @url = ("http://banana.com/one/coupon/abcdedfg-1234-jakl/info.json?"+
+                "hash=97c68554af339f1017155b1c4eb4cf3d14039bea")
+      end
+
+      should "work if status is zero" do
+        jsonstr = {
+          :status => 0,
+          :coupons => [{"in_game_coupon" => {
+                           :code         => 'fubar',
+                           :download_url => "http://example.com?dd",
+                           :state        => 'all good',
+                           :app_id       => "1231121",
+                         }},
+                       {"fubar" => {
+                           :code         => 'snafu',
+                           :download_url => "http://example.com?dd/snahf",
+                           :state        => 'all bad',
+                           :app_id       => 12131412,
+                         }}]}.to_json
+        mock_rest_client(jsonstr)
+
+        cpns = @app.coupon("abcdedfg-1234-jakl").info
+        assert_equal 2, cpns.count
+
+        cpn = cpns.first
+        assert_equal "1231121", cpn.app_id
+        assert_equal "fubar", cpn.code
+        assert_equal "http://example.com?dd", cpn.url
+        assert_equal 'all good', cpn.state
+
+        cpn = cpns.last
+        assert_equal 12131412, cpn.app_id
+        assert_equal "http://example.com?dd/snahf", cpn.url
+        assert_equal 'all bad', cpn.state
+        assert_equal 'snafu', cpn.code
+      end
+
+      should "die if the status is not zero" do
+        mock_rest_client('{ "status" : "banana" }')
+
+        assert_raise HitfoxCouponApi::Client::HitfoxApiException do
+          @app.coupon("abcdedfg-1234-jakl").info
+        end
+      end
+    end
+
+    context "coupon adding" do
+      setup do
+        @url = ("http://banana.com/one/coupons/create.json?"+
+                "hash=6f6e6aab956d49491b799daf4ed6f8cdadb3ee59")
+      end
+
+      should "generate hash based on count" do
+        ary = [:one,:two,:three,:four]
+        mock.instance_of(HitfoxCouponApi::Configuration).
+          generate_timestamp { '1314792296' }
+        mock(RestClient).post(@url.gsub(/6f6e6aab956d49491b799daf4ed6f8cdadb3ee59/,
+                                        "b99ac8c4a3027c6bbe759cfc8179bd338bfd6e14"),
+                              { :coupons => ary}, @header) { '{ "status" : 1 }'}
+
+        HitfoxCouponApi::Application.new("productidentiefer").add_coupons(ary)
+      end
+
+      should "generate hash based on count not content of array" do
+        ary = [:oned,:twod,:dthree,:dfour]
+        mock.instance_of(HitfoxCouponApi::Configuration).
+          generate_timestamp { '1314792296' }
+        mock(RestClient).post(@url.gsub(/6f6e6aab956d49491b799daf4ed6f8cdadb3ee59/,
+                                        "b99ac8c4a3027c6bbe759cfc8179bd338bfd6e14"),
+                              { :coupons => ary}, @header) { '{ "status" : 1 }'}
+
+        @app.add_coupons(ary)
+      end
+
+      should "raise exception with bang" do
+        ary = [:one,:two,:three]
+        mock.instance_of(HitfoxCouponApi::Configuration).
+          generate_timestamp { '1314792296' }
+        mock(RestClient).post(@url, { :coupons => ary}, @header) { '{ "status" : 1 }'}
+
+        assert_raise HitfoxCouponApi::Client::HitfoxApiException do
+          @app.add_coupons!(ary)
+        end
+      end
+
+      should "work with bang also" do
+        ary = [:one,:two,:three]
+        mock.instance_of(HitfoxCouponApi::Configuration).
+          generate_timestamp { '1314792296' }
+        mock(RestClient).post(@url, { :coupons => ary}, @header) { '{ "status" : 0 }'}
+
+        @app.add_coupons!(ary)
+      end
+
+      should "work" do
+        ary = [:one,:two,:three]
+        mock.instance_of(HitfoxCouponApi::Configuration).
+          generate_timestamp { '1314792296' }
+        mock(RestClient).post(@url, { :coupons => ary}, @header) { '{ "status" : 0 }'}
+
+        @app.add_coupons(ary)
+      end
+    end
+
+    context "coupon used" do
+      setup do
+        @url = ("http://banana.com/one/coupon/abcdedfg-1234-jakl/used.json?"+
+                "hash=97c68554af339f1017155b1c4eb4cf3d14039bea")
+      end
+
+      should "have a bang variation for throwing exceptions" do
+        cpn = @app.coupon("abcdedfg-1234-jakl")
+
+        mock(cpn).used { { "status" => 1 }}
+        assert_raise HitfoxCouponApi::Client::HitfoxApiException do
+          cpn.used!
+        end
+      end
+
+      should "have a bang variation for returning true" do
+        product = HitfoxCouponApi::Application.new("productidentiefer")
+        cpn = product.coupon("abcdedfg-1234-jakl")
+        mock(cpn).used { { "status" => 0 }}
+        assert cpn.used
+      end
+
+      should "generate the correct hash value" do
+        mock_rest_client('{ "status" : "banana" }')
+
+        hsh = @app.coupon("abcdedfg-1234-jakl").used
+
+        assert_equal "banana", hsh["status"]
+      end
+
+      should "propagate exceptions" do
+        mock(RestClient).get.with_any_args do
+          raise RuntimeError, "no good"
+        end
+
+        assert_raise RuntimeError do
+          @app.coupon("asdsad").used
+        end
+      end
+    end
+  end
+end

data/test/test_hitfox_coupon_api.rb

@@ -1,60 +1,109 @@
 require File.dirname(__FILE__)+'/helper'
 
 class TestHitfoxCouponApi < Test::Unit::TestCase
-  context "coupon used" do
+
+  context "hitfox api" do
     setup do
-      HitfoxCouponApi.configure do |c|
-        c.api_token = "1234"
-        c.api_secret = "2143abce"
-        c.api_version = "one"
-        c.api_endpoint = "http://banana.com"
-      end
+      setup_api_and_header
     end
 
-    should "generate the correct hash value" do
-      url = ("http://banana.com/one/coupon/abcdedfg-1234-jakl/used.json?"+
-             "hash=97c68554af339f1017155b1c4eb4cf3d14039bea")
-      header = {
-        "X-API-APP-ID"    => "productidentiefer",
-        "X-API-TIMESTAMP" => "1314792296",
-        "X-API-TOKEN"     => "1234"
-      }
+    context "configuration can be application specific" do
+      should "have default global configuration" do
+        app1 = HitfoxCouponApi.application("12131")
+        assert_nil app1.configuration
+        assert_equal "http://banana.com", app1.user("121").configuration.api_endpoint
+      end
 
-      mock.instance_of(HitfoxCouponApi::Configuration).generate_timestamp { '1314792296' }
-      mock(RestClient).get(url,header) { '{ "status" : "banana" }'}
+      should "can have application specific configuration" do
+        app1 = HitfoxCouponApi.application("12131")
+        assert_nil app1.configuration
+        user = app1.user("121")
+        assert_equal "http://banana.com", user.configuration.api_endpoint
 
-      product = HitfoxCouponApi::Application.new("productidentiefer")
-      hsh = product.coupon("abcdedfg-1234-jakl").used
+        app1.configure { |c| c.api_endpoint = "http://new.endpoint.com" }
+        assert_equal "http://new.endpoint.com", app1.user("121").configuration.api_endpoint
+        assert_equal "http://new.endpoint.com", user.configuration.api_endpoint
 
-      assert_equal "banana", hsh["status"]
-    end
+        # but remains application specific
+        app2 = HitfoxCouponApi.application("12131")
+        assert_equal "http://banana.com", app2.user("121").configuration.api_endpoint
+        assert_equal "http://new.endpoint.com", app1.user("1").configuration.api_endpoint
+      end
 
-    should "provide a shortcut application instanciation method" do
-      url = ("http://banana.com/one/coupon/abcdedfg-1234-jakl/used.json?"+
-             "hash=97c68554af339f1017155b1c4eb4cf3d14039bea")
-      header = {
-        "X-API-APP-ID"    => "productidentiefer",
-        "X-API-TIMESTAMP" => "1314792296",
-        "X-API-TOKEN"     => "1234"
-      }
+      should "global configuration provides default values for things not set" do
+        app1 = HitfoxCouponApi.application("12131")
+        app1.configure { |c| c.api_endpoint = "http://new.endpoint.com" }
 
-      mock.instance_of(HitfoxCouponApi::Configuration).generate_timestamp { '1314792296' }
-      mock(RestClient).get(url,header) { '{ "status" : "banana" }' }
+        user = app1.user("1211")
+        url = ("http://new.endpoint.com/one/coupon/1211/buy.json?"+
+               "hash=5d13dc25ee89649c5e02c3b93f0f9f4faa6d6d21&count=1")
 
-      hsh = HitfoxCouponApi.application("productidentiefer").
-        coupon("abcdedfg-1234-jakl").used
+        header = {
+          "X-API-APP-ID"    => "12131",
+          "X-API-TIMESTAMP" => "1314792296",
+          "X-API-TOKEN"     => "1234"
+        }
+        mock(app1.configuration).generate_timestamp { "1314792296" }
+        mock(RestClient).get(url,header) { '{ "status" : 1, "msg" : "no message" }'}
 
-      assert_equal "banana", hsh["status"]
+        assert_raise HitfoxCouponApi::Client::HitfoxApiException do
+          user.buy_coupon
+        end
+      end
     end
 
-    should "propagate exceptions" do
-      product = HitfoxCouponApi::Application.new("productidentiefer")
-      mock(RestClient).get.with_any_args do
-        raise RuntimeError, "no good"
+    context "client helpers" do
+      setup do
+        @cpnres = {
+          "status" => 0,
+          "coupons" => [ "some_key" => {
+                           "app_id"       => 'fubar',
+                           "code"         => "edoc",
+                           "download_url" => "url",
+                           "state"        => "active"
+                         }
+                       ]
+        }
+
+        @client = Class.new(HitfoxCouponApi::Client) do
+          def initialize(app)
+            @application = app
+          end
+        end.new(HitfoxCouponApi::Application.new("fubar"))
+      end
+
+      should "be able to generate a url" do
+        assert_equal "http://banana.com", @client.generate_url("",[])
+        assert_equal "http://banana.com/path", @client.generate_url("/%s",["path"])
+        assert_equal("http://banana.com/path?c=%2B%3F%26%2F",
+                     @client.generate_url("/%s?c=%s",["path","+?&/"]))
+      end
+
+      should "handle a coupon return value - raise exception if status non zero" do
+        assert_raise HitfoxCouponApi::Client::HitfoxApiException do
+          @client.handle_coupon_results({"status" => 1})
+        end
+      end
+
+      should "handle coupon results" do
+        cpns = @client.handle_coupon_results(@cpnres)
+        assert_equal 1, cpns.count
+        assert_equal "edoc", cpns.first.code
+        assert_equal "url", cpns.first.url
+        assert_equal nil, cpns.first.state
       end
 
-      assert_raise RuntimeError do
-        product.coupon("asdsad").used
+      should "handle coupon results and yield to block" do
+        cpns = @client.handle_coupon_results(@cpnres) do |cc|
+          HitfoxCouponApi::Coupon.new(HitfoxCouponApi::Application.new(cc["app_id"]),
+                                      cc["code"], cc["download_url"]).tap do |cpn|
+            cpn.state = cc["state"]
+          end
+        end
+        assert_equal 1, cpns.count
+        assert_equal "edoc", cpns.first.code
+        assert_equal "url", cpns.first.url
+        assert_equal "active", cpns.first.state
       end
     end
   end

data/test/test_order.rb

@@ -0,0 +1,115 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TestOrder < Test::Unit::TestCase
+  context "order functionality" do
+    setup do
+      setup_api_and_header
+      @app = HitfoxCouponApi::Application.new("productidentiefer")
+    end
+
+    context "reserve coupons" do
+      setup do
+        @url = ("http://banana.com/one/coupon/1231/reserve.json?"+
+                "hash=09b0150d9aeabb6d61427864f0c637051e69cf40&count=2")
+      end
+
+      should "fail with status non zero" do
+        mock_rest_client
+        assert_raise HitfoxCouponApi::Client::HitfoxApiException do
+          order = @app.order("1231").reserve(2)
+        end
+      end
+
+      should "work well enough" do
+        jsonstr = {
+          :status => 0,
+          :coupons => [{"in_game_coupon" => {
+                         :code => 'fubar',
+                         :download_url => "http://example.com?dd"
+                       }},
+                       {"fubar" => {
+                         :code => 'snafu',
+                         :download_url => "http://example.com?dd/snahf"
+                       }}]}.to_json
+
+        mock_rest_client(jsonstr)
+        cpns = @app.order("1231").reserve(2)
+        assert_equal 2, cpns.count
+        assert_equal "fubar", cpns.first.code
+        assert_equal "http://example.com?dd", cpns.first.url
+        assert_equal "snafu", cpns.last.code
+        assert_equal "http://example.com?dd/snahf", cpns.last.url
+      end
+    end
+
+    context "paid coupons" do
+      setup do
+        @url = ("http://banana.com/one/coupon/1231/paid.json?"+
+                "hash=09b0150d9aeabb6d61427864f0c637051e69cf40")
+      end
+
+      should "fail with status non zero" do
+        mock_rest_client
+        assert_raise HitfoxCouponApi::Client::HitfoxApiException do
+          order = @app.order("1231").paid
+        end
+      end
+
+      should "work well enough" do
+        jsonstr = {
+          :status => 0,
+          :coupons => [{"in_game_coupon" => {
+                         :code => 'fubar',
+                         :download_url => "http://example.com?dd"
+                       }},
+                       {"fubar" => {
+                         :code => 'snafu',
+                         :download_url => "http://example.com?dd/snahf"
+                       }}]}.to_json
+
+        mock_rest_client(jsonstr)
+        cpns = @app.order("1231").paid
+        assert_equal 2, cpns.count
+        assert_equal "fubar", cpns.first.code
+        assert_equal "http://example.com?dd", cpns.first.url
+        assert_equal "snafu", cpns.last.code
+        assert_equal "http://example.com?dd/snahf", cpns.last.url
+      end
+    end
+
+    context "obtain a list of coupons" do
+      setup do
+        @url = ("http://banana.com/one/coupon/1231/list.json?"+
+                "hash=09b0150d9aeabb6d61427864f0c637051e69cf40")
+      end
+
+      should "fail with status non zero" do
+        mock_rest_client
+        assert_raise HitfoxCouponApi::Client::HitfoxApiException do
+          order = @app.order("1231").coupons
+        end
+      end
+
+      should "work well enough" do
+        jsonstr = {
+          :status => 0,
+          :coupons => [{"in_game_coupon" => {
+                         :code => 'fubar',
+                         :download_url => "http://example.com?dd"
+                       }},
+                       {"fubar" => {
+                         :code => 'snafu',
+                         :download_url => "http://example.com?dd/snahf"
+                       }}]}.to_json
+
+        mock_rest_client(jsonstr)
+        cpns = @app.order("1231").coupons
+        assert_equal 2, cpns.count
+        assert_equal "fubar", cpns.first.code
+        assert_equal "http://example.com?dd", cpns.first.url
+        assert_equal "snafu", cpns.last.code
+        assert_equal "http://example.com?dd/snahf", cpns.last.url
+      end
+    end
+  end
+end

data/test/test_user.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/helper'
+
+class TestUser < Test::Unit::TestCase
+  context "user functionality" do
+    setup do
+      setup_api_and_header
+      @app = HitfoxCouponApi::Application.new("productidentiefer")
+    end
+
+    context "user coupon listing" do
+      setup do
+        @url = ("http://banana.com/one/coupon/1231/show.json?"+
+                "hash=09b0150d9aeabb6d61427864f0c637051e69cf40")
+      end
+
+      should "fail if status is non zero" do
+        mock_rest_client
+
+        assert_raise HitfoxCouponApi::Client::HitfoxApiException do
+          @app.user("1231").coupons
+        end
+      end
+
+      should "succeed if status zero" do
+        jsonstr = {
+          :status => 0,
+          :coupons => [{"in_game_coupon" => {
+                         :code => 'fubar',
+                         :download_url => "http://example.com?dd"
+                       }},
+                       {"fubar" => {
+                         :code => 'snafu',
+                         :download_url => "http://example.com?dd/snahf"
+                       }}]}.to_json
+
+        mock_rest_client(jsonstr)
+
+        cpns = @app.user("1231").coupons
+        assert_equal 2, cpns.count
+        assert_equal "fubar", cpns.first.code
+        assert_equal "http://example.com?dd", cpns.first.url
+        assert_equal "snafu", cpns.last.code
+        assert_equal "http://example.com?dd/snahf", cpns.last.url
+      end
+    end
+
+    context "user coupon purchase" do
+      setup do
+        @url = ("http://banana.com/one/coupon/1231/buy.json?"+
+                "hash=09b0150d9aeabb6d61427864f0c637051e69cf40&count=1")
+      end
+
+      should "fail if status non-zero" do
+        mock_rest_client
+
+        assert_raise HitfoxCouponApi::Client::HitfoxApiException do
+          @app.user("1231").buy_coupon
+        end
+      end
+
+      should "generate coupons if all is well" do
+        jsonstr = {
+          :status => 0,
+          :coupons => [{"in_game_coupon" => {
+                         :code => 'fubar',
+                         :download_url => "http://example.com?dd"
+                       }},
+                       {"fubar" => {
+                         :code => 'snafu',
+                         :download_url => "http://example.com?dd/snahf"
+                       }}]}.to_json
+        mock_rest_client(jsonstr)
+
+        cpns = @app.user("1231").buy_coupon
+        assert_equal 2, cpns.count
+        assert_equal "fubar", cpns.first.code
+        assert_equal "http://example.com?dd", cpns.first.url
+        assert_equal "snafu", cpns.last.code
+        assert_equal "http://example.com?dd/snahf", cpns.last.url
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hitfox_coupon_api
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Gerrit Riessen
@@ -15,10 +15,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-01 00:00:00 Z
+date: 2012-05-02 00:00:00 +02:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -28,11 +30,11 @@ dependencies:
         - 0
         version: "0"
   name: rest-client
+  version_requirements: *id001
   prerelease: false
-  type: :runtime
-  requirement: *id001
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -42,11 +44,11 @@ dependencies:
         - 0
         version: "0"
   name: json
+  version_requirements: *id002
   prerelease: false
-  type: :runtime
-  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -58,11 +60,11 @@ dependencies:
         - 7
         version: 0.8.7
   name: rake
+  version_requirements: *id003
   prerelease: false
-  type: :development
-  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -72,11 +74,11 @@ dependencies:
         - 0
         version: "0"
   name: pry
+  version_requirements: *id004
   prerelease: false
-  type: :development
-  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -86,11 +88,11 @@ dependencies:
         - 0
         version: "0"
   name: pry-doc
+  version_requirements: *id005
   prerelease: false
-  type: :development
-  requirement: *id005
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -100,11 +102,11 @@ dependencies:
         - 0
         version: "0"
   name: gist
+  version_requirements: *id006
   prerelease: false
-  type: :development
-  requirement: *id006
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -113,28 +115,26 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: thoughtbot-shoulda
+  name: shoulda
+  version_requirements: *id007
   prerelease: false
-  type: :development
-  requirement: *id007
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 3
         segments: 
-        - 1
         - 0
-        - 0
-        version: 1.0.0
+        version: "0"
   name: bundler
+  version_requirements: *id008
   prerelease: false
-  type: :development
-  requirement: *id008
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -146,11 +146,11 @@ dependencies:
         - 4
         version: 1.6.4
   name: jeweler
+  version_requirements: *id009
   prerelease: false
-  type: :development
-  requirement: *id009
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -160,11 +160,11 @@ dependencies:
         - 0
         version: "0"
   name: rcov
+  version_requirements: *id010
   prerelease: false
-  type: :development
-  requirement: *id010
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id011 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -174,11 +174,11 @@ dependencies:
         - 0
         version: "0"
   name: rr
+  version_requirements: *id011
   prerelease: false
-  type: :development
-  requirement: *id011
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id012 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -188,9 +188,8 @@ dependencies:
         - 0
         version: "0"
   name: cheat
+  version_requirements: *id012
   prerelease: false
-  type: :development
-  requirement: *id012
 description: Simple JSON interface to the HitFox coupon API
 email: gerrit.riessen@gmail.com
 executables: []
@@ -202,7 +201,9 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- .keep
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -211,12 +212,19 @@ files:
 - hitfox_coupon_api.gemspec
 - lib/hitfox_coupon_api.rb
 - lib/hitfox_coupon_api/application.rb
+- lib/hitfox_coupon_api/client.rb
 - lib/hitfox_coupon_api/configuration.rb
 - lib/hitfox_coupon_api/coupon.rb
+- lib/hitfox_coupon_api/order.rb
+- lib/hitfox_coupon_api/user.rb
 - test/.login.yml.sample
 - test/helper.rb
+- test/test_coupon.rb
 - test/test_hitfox_coupon_api.rb
+- test/test_order.rb
+- test/test_user.rb
 - test_shell
+has_rdoc: true
 homepage: https://github.com/gorenje/hitfox_coupon_api
 licenses: 
 - MIT
@@ -246,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Simple JSON interface to the HitFox coupon API