ruby-promobox 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4e531ad0f13cc26fa696d41b6f351cb16d7a974
+  data.tar.gz: ec7d65e6234fe848b7e407ba4610a1cda47ead9e
+SHA512:
+  metadata.gz: 0b36ea840c238919de359b6ca6b63e2634f42bb38ba431c87cf63ea0b5bce980f6d51819ba159bbb37ddcd2ddbf7f07996e2b3e3e2b462f664ea6861b0727b87
+  data.tar.gz: d74dfa6fbaa1c37f489583ef443f491eba557c6817d42961558f3a978067504cd0090efbbbbe4d3e954a52f7cc6b640680235397b01d2b8cbe73e13bdc65963e

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2013 Laurent Arnoud <laurent.arnoud@af83.com>
+
+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.markdown

@@ -0,0 +1,33 @@
+ruby-promobox
+=============
+
+Usage
+-----
+
+
+```ruby
+@promobox = Promobox.new('apikey', 'demo@atipik.fr', 'password')
+```
+
+Implemented methods:
+
+```ruby
+@promobox.search(params)
+@promobox.coupons(params)
+@promobox.shops(params)
+@promobox.coupon(id)
+@promobox.shop(id)
+```
+
+Resources
+---------
+
+* http://promobox.fr/
+* http://api.promobox.fr/doc/
+
+Tests
+-----
+
+``` ruby
+bundle exec ruby test/promobox_test.rb
+```

data/lib/promobox.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+require 'digest/md5'
+require 'digest/sha1'
+require 'base64'
+require 'uri'
+require 'open-uri'
+require 'multi_json'
+
+class Promobox
+
+  API_VERSION = 'v3'
+  API_URL = "http://api.promobox.fr/api/#{API_VERSION}"
+
+  def initialize(api_key, login, password)
+    @api_key = api_key
+    @login = login
+    @password = password
+    @hash_password = Digest::MD5.digest("#{@password}{#{@api_key}}").unpack('H*').first
+  end
+
+  %w{coupons search shops}.each do |m|
+    define_method m do |*params|
+      url = build_query(m, params.first || {})
+      decode_url(url)
+    end
+  end
+
+  def coupon(id)
+    url = build_query("#{__method__}/#{id}")
+    decode_url(url)
+  end
+
+  def shop(id)
+    url = build_query("#{__method__}/#{id}")
+    decode_url(url)
+  end
+
+  private
+
+  def decode_url(url)
+    response = Kernel.open(url)
+    MultiJson.decode(response)
+  end
+
+  def build_query(action, params = {})
+    ts = Time.now.to_i
+    token = Base64.encode64(Digest::SHA1.digest("#{@hash_password}#{ts}#{@api_key}")).chomp
+    query = {
+      ts: ts.to_s,
+      login: @login,
+      token: token
+    }
+    auth_params = URI.encode_www_form query
+    encoded_params = URI.encode_www_form params
+    url = "#{API_URL}/#{action}?#{auth_params}"
+    url += "&#{encoded_params}" unless params.nil? || params.empty?
+    url
+  end
+end

data/test/promobox_test.rb

@@ -0,0 +1,140 @@
+# encoding: UTF-8
+require_relative 'test_helper'
+
+describe Promobox do
+  include RR::Adapters::TestUnit
+
+  before do
+    @promobox = Promobox.new('apikey', 'demo@atipik.fr', 'password')
+  end
+
+  def promobox_stub(action, params={})
+    file = "#{action}.json"
+    file = "#{action}_#{URI.encode_www_form params}.json" unless params.empty?
+    fixture_file = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', file))
+    url = @promobox.send(:build_query, action, params)
+    stub(Kernel).open(url) { File.read fixture_file }
+  end
+
+  describe 'search' do
+    before do
+      promobox_stub('search')
+    end
+
+    it 'should respond' do
+      search = @promobox.search
+      search.must_be_instance_of Hash
+      search['data'].wont_be_empty
+      search['total_page'].must_equal 22
+      search['total_item'].must_equal 430
+    end
+  end
+
+  describe 'coupons' do
+    before do
+      promobox_stub('coupons')
+    end
+
+    it 'should respond' do
+      coupons = @promobox.coupons
+      coupons.must_be_instance_of Hash
+      coupons['data'].wont_be_empty
+      coupons['current_page'].must_equal 1
+      coupons['total_page'].must_equal 28
+      coupons['total_item'].must_equal 544
+    end
+  end
+
+  describe 'shops' do
+    describe 'without params' do
+      before do
+        promobox_stub('shops')
+      end
+
+      it 'should respond empty data' do
+        shops = @promobox.shops
+        shops.must_be_instance_of Hash
+        shops['data'].must_be_empty
+        shops['current_page'].must_equal 1
+        shops['total_page'].must_equal 0
+        shops['total_item'].must_equal 0
+      end
+    end
+
+    describe 'with params' do
+      before do
+        @params = {lat: '49.824837', lon: '3.280160'}
+        promobox_stub('shops', @params)
+      end
+
+      it 'should respond' do
+        shops = @promobox.shops(@params)
+        shops.must_be_instance_of Hash
+        shops['data'].wont_be_empty
+        shops['current_page'].must_equal 1
+        shops['total_page'].must_equal 260
+        shops['total_item'].must_equal 5187
+      end
+    end
+  end
+
+  describe 'coupon' do
+    it 'must have an id' do
+      proc { @promobox.coupon }.must_raise ArgumentError
+    end
+
+    describe 'invalid id' do
+      before do
+        promobox_stub('coupon/af83')
+      end
+
+      it 'should respond' do
+        coupon = @promobox.coupon 'af83'
+        coupon['status'].must_equal 'error'
+        coupon['status_code'].must_equal 404
+      end
+    end
+
+    describe 'valid id' do
+      before do
+        promobox_stub('coupon/7465')
+      end
+
+      it 'should respond' do
+        coupon = @promobox.coupon '7465'
+        coupon['status'].must_equal nil
+        coupon['id'].must_equal 7465
+      end
+    end
+  end
+
+  describe 'shop' do
+    it 'must have an id' do
+      proc { @promobox.shop }.must_raise ArgumentError
+    end
+
+    describe 'invalid id' do
+      before do
+        promobox_stub('shop/af83')
+      end
+
+      it 'should respond' do
+        shop = @promobox.shop 'af83'
+        shop['status'].must_equal 'error'
+        shop['status_code'].must_equal 404
+      end
+    end
+
+    describe 'valid id' do
+      before do
+        promobox_stub('shop/2004')
+      end
+
+      it 'should respond' do
+        shop = @promobox.shop '2004'
+        shop['status'].must_equal nil
+        shop['id'].must_equal 2004
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+require 'minitest/autorun'
+require 'rr'
+require 'promobox'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: ruby-promobox
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Laurent Arnoud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+description: Ruby API promobox
+email: laurent.arnoud@af83.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- LICENSE
+- README.markdown
+- Gemfile
+- lib/promobox.rb
+- test/test_helper.rb
+- test/promobox_test.rb
+homepage: http://github.com/AF83/ruby-promobox
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Ruby lib for talking with promobox API
+test_files:
+- test/promobox_test.rb