spreadshirt_client 0.0.6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Benjamin Vetter
+
+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,61 @@
+
+# SpreadshirtClient
+
+Use this gem to communicate with the spreadshirt API.
+http://developer.spreadshirt.net
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spreadshirt_client'
+
+And then execute:
+
+    $ bundle
+
+## Setup
+
+First, you need to setup your API credentials:
+
+<pre>
+SpreadshirtClient.api_key = "..."
+SpreadshirtClient.api_secret = "..."
+SpreadshirtClient.base_url = "http://api.spreadshirt.net/api/v1" # optional
+SpreadshirtClient.timeout = 5 # optional (default: 30)
+</pre>
+
+## Usage
+
+The DSL to interact with the spreadshirt API is similar
+to RestClient's DSL.
+
+<pre>
+# Add an article to a previously created spreadshirt basket.
+SpreadshirtClient.post "/baskets/[basket_id]/items", "<basketItem>...</basketItem>", :authorization => true
+
+# To make a request that requires a valid spreadshirt session.
+SpreadshirtClient.post "/orders", "<order>...</order>", :authorization => true, :session => "..."
+
+# Update a line item.
+SpreadshirtClient.put "/baskets/[basket_id]/items/[item_id]", "<basketItem>...</basketItem>", :authorization => true
+
+# Retrieve the checkout url for a spreadshirt basket.
+SpreadshirtClient.get "/baskets/[basket_id]/checkout", :authorization => true
+
+# Retrieve a spreadshirt shop's articles.
+SpreadshirtClient.get "/shops/[shop_id]/articles", :params => { :limit => 50 }
+
+...
+</pre>
+
+Please take a look into the spreadshirt API docs for more details.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t| 
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+

data/lib/spreadshirt_client.rb

@@ -0,0 +1,80 @@
+
+require "spreadshirt_client/version"
+require "rubygems"
+require "rest-client"
+require "timeout"
+
+module SpreadshirtClient
+  class << self
+    attr_accessor :api_key, :api_secret
+
+    def timeout=(timeout)
+      @timeout = timeout
+    end
+
+    def timeout
+      @timeout || 30
+    end
+
+    def base_url=(base_url)
+      @base_url = base_url
+    end
+
+    def base_url
+      @base_url || "http://api.spreadshirt.net/api/v1"
+    end
+
+    def authorize(method, path, session = nil)
+      time = Time.now.to_i
+
+      authorization = [
+        "apiKey=\"#{api_key}\"",
+        "data=\"#{method} #{url_for path} #{time}\"",
+        "sig=\"#{Digest::SHA1.hexdigest "#{method} #{url_for path} #{time} #{api_secret}"}\""
+      ]
+
+      res = []
+      res.push "SprdAuth #{authorization.join ", "}"
+      res.push "sessionId=\"#{session}\"" if session
+
+      res.join ", "
+    end
+
+    def url_for(path)
+      return path if path =~ /\Ahttps?:\/\//
+
+      "#{base_url}#{path}"
+    end
+
+    def headers_for(method_symbol, path, options)
+      headers = {}
+
+      headers[:authorization] = authorize(method_for(method_symbol), path, options[:session]) if options[:authorization]
+
+      opts = options.dup
+      opts.delete :session
+      opts.merge headers
+    end
+
+    def method_for(method_symbol)
+      method_symbol.to_s.upcase
+    end
+
+    def put(path, payload, options = {})
+      Timeout::timeout(timeout) { RestClient.put url_for(path), payload, headers_for(:put, path, options) }
+    end
+
+    def post(path, payload, options = {})
+      Timeout::timeout(timeout) { RestClient.post url_for(path), payload, headers_for(:post, path, options) }
+    end
+
+    def get(path, options = {})
+      Timeout::timeout(timeout) { RestClient.get url_for(path), headers_for(:get, path, options) }
+    end
+
+    def delete(path, options = {})
+      Timeout::timeout(timeout) { RestClient.delete url_for(path), headers_for(:delete, path, options) }
+    end
+  end
+end
+

data/lib/spreadshirt_client/version.rb

@@ -0,0 +1,3 @@
+module SpreadshirtClient
+  VERSION = "0.0.6"
+end

data/spreadshirt_client.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "spreadshirt_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "spreadshirt_client"
+  s.version     = SpreadshirtClient::VERSION
+  s.authors     = ["Benjamin Vetter"]
+  s.email       = ["vetter@flakks.com"]
+  s.homepage    = "https://github.com/mrkamel/spreadshirt_client"
+  s.summary     = %q{Communicate with the spreadshirt API}
+  s.description = %q{Communicate with the spreadshirt API using a DSL similar to the one of RestClient}
+
+  s.rubyforge_project = "spreadshirt_client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "mocha"
+  s.add_dependency "rest-client"
+end
+

data/test/spreadshirt_client_test.rb

@@ -0,0 +1,96 @@
+
+require File.expand_path("../../lib/spreadshirt_client", __FILE__)
+require "test/unit"
+require "mocha"
+
+class SpreadshirtClientTest < Test::Unit::TestCase
+  def setup
+    SpreadshirtClient.api_key = "test"
+    SpreadshirtClient.api_secret = "test"
+
+    Time.expects(:now).returns(Time.utc(2012, 1, 1)).at_least(0)
+  end
+
+  def test_api_key
+    assert_nothing_raised { SpreadshirtClient.api_key }
+  end
+
+  def test_api_secret
+    assert_nothing_raised { SpreadshirtClient.api_secret }
+  end
+
+  def test_base_url
+    assert_equal "http://api.spreadshirt.net/api/v1", SpreadshirtClient.base_url
+
+    SpreadshirtClient.base_url = "http://test.spreadshirt.net/api/v1"
+
+    assert_equal "http://test.spreadshirt.net/api/v1", SpreadshirtClient.base_url
+
+    SpreadshirtClient.base_url = "http://api.spreadshirt.net/api/v1"
+  end
+
+  def test_authorize
+    assert_equal 'SprdAuth apiKey="test", data="post http://api.spreadshirt.net/api/v1/baskets/1/items 1325376000", sig="932555fa9cc0854b03473487af521045dc12d3d0"', SpreadshirtClient.authorize(:post, "/baskets/1/items")
+  end
+
+  def test_authorize_with_session
+    regex = /\ASprdAuth apiKey=\"test\", data=\"post http:\/\/api.spreadshirt.net\/api\/v1\/orders [0-9]+\", sig=\"[0-9a-f]{40}\", sessionId=\"abcd-1234\"\Z/
+
+    assert SpreadshirtClient.authorize(:post, "/orders", "abcd-1234") =~ regex
+  end
+
+  def test_url_for
+    assert_equal "http://api.spreadshirt.net/api/v1/basket/1/items", SpreadshirtClient.url_for("/basket/1/items")
+    assert_equal "http://test.spreadshirt.net/api/v1/basket/1/items", SpreadshirtClient.url_for("http://test.spreadshirt.net/api/v1/basket/1/items")
+  end
+
+  def test_headers_for
+    headers = SpreadshirtClient.headers_for(:post, "/basket/1/items", :authorization => true, :session => "abcd-1234")
+
+    assert_equal [:authorization], headers.keys
+
+    assert headers[:authorization].include?("SprdAuth")
+    assert headers[:authorization].include?("abcd-1234")
+
+    assert_equal({ :params => { :limit => 500 } }, SpreadshirtClient.headers_for(:get, "/shops/1/articles", :params => { :limit => 500 }))
+  end
+
+  def test_method_for
+    assert_equal "POST", SpreadshirtClient.method_for(:post)
+  end
+
+  def test_timeout
+    assert_equal 30, SpreadshirtClient.timeout
+
+    SpreadshirtClient.timeout = 5
+
+    assert_equal 5, SpreadshirtClient.timeout
+
+    SpreadshirtClient.timeout = 30
+  end
+
+  def test_put
+    RestClient.expects(:put).with("http://api.spreadshirt.net/api/v1/baskets/1/items/1", "payload", :authorization => 'SprdAuth apiKey="test", data="PUT http://api.spreadshirt.net/api/v1/baskets/1/items/1 1325376000", sig="2f7a28edc68bbec83a8a580bbd1506ba9192f68e"').returns(200)
+
+    assert_equal 200, SpreadshirtClient.put("/baskets/1/items/1", "payload", :authorization => true)
+  end
+
+  def test_post
+    RestClient.expects(:post).with("http://api.spreadshirt.net/api/v1/baskets", "payload", :authorization => 'SprdAuth apiKey="test", data="POST http://api.spreadshirt.net/api/v1/baskets 1325376000", sig="04097ac87eadc5d6d0766b2dabf509ebc35eb3bc"').returns(200)
+
+    assert_equal 200, SpreadshirtClient.post("/baskets", "payload", :authorization => true)
+  end
+
+  def test_get
+    RestClient.expects(:get).with("http://api.spreadshirt.net/api/v1/orders/1", :authorization => 'SprdAuth apiKey="test", data="GET http://api.spreadshirt.net/api/v1/orders/1 1325376000", sig="7f06c7604b97b682c545262bd9acbbaf04eb8fcd", sessionId="abcd-1234"').returns(200)
+
+    assert_equal 200, SpreadshirtClient.get("/orders/1", :authorization => true, :session => "abcd-1234")
+  end
+
+  def test_delete
+    RestClient.expects(:delete).with("http://api.spreadshirt.net/api/v1/baskets/1/items/1", :authorization => 'SprdAuth apiKey="test", data="DELETE http://api.spreadshirt.net/api/v1/baskets/1/items/1 1325376000", sig="010f76d9c0a01278872a897b72bcac4daf0109cf"').returns(200)
+
+    assert_equal 200, SpreadshirtClient.delete("/baskets/1/items/1", :authorization => true)
+  end
+end
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: spreadshirt_client
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- Benjamin Vetter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Communicate with the spreadshirt API using a DSL similar to the one of
+  RestClient
+email:
+- vetter@flakks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/spreadshirt_client.rb
+- lib/spreadshirt_client/version.rb
+- spreadshirt_client.gemspec
+- test/spreadshirt_client_test.rb
+homepage: https://github.com/mrkamel/spreadshirt_client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: '0'
+requirements: []
+rubyforge_project: spreadshirt_client
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Communicate with the spreadshirt API
+test_files: []