spreadshirt_client 0.0.6 → 0.0.7

data/README.md

@@ -1,4 +1,3 @@
-
 # SpreadshirtClient
 
 Use this gem to communicate with the spreadshirt API.
@@ -8,29 +7,39 @@ http://developer.spreadshirt.net
 
 Add this line to your application's Gemfile:
 
-    gem 'spreadshirt_client'
+```
+gem 'spreadshirt_client'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
+
+Alternatively, you can of course install it without bundler via:
+
+```
+$ gem install spreadshirt_client
+```
 
 ## Setup
 
 First, you need to setup your API credentials:
 
-<pre>
+```ruby
 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>
+```ruby
 # Add an article to a previously created spreadshirt basket.
 SpreadshirtClient.post "/baskets/[basket_id]/items", "<basketItem>...</basketItem>", :authorization => true
 
@@ -47,9 +56,94 @@ SpreadshirtClient.get "/baskets/[basket_id]/checkout", :authorization => true
 SpreadshirtClient.get "/shops/[shop_id]/articles", :params => { :limit => 50 }
 
 ...
-</pre>
+```
+
+## Examples
+
+### Creating a basket on spreadshirt
+
+(This example is made for Rails 3.x+ applications)
+
+Create your own basket model:
+
+```bash
+$ rails g model Basket spreadshirt_id:string:uniq
+```
+
+Run the migration
+
+```
+$ rake db:migrate
+```
+
+Modify your model:
+
+```ruby
+# An example of a basket model
+
+class Basket < ActiveRecord::Base
+  before_create :create_spreadshirt_basket
+
+  # Find our stored basket by using the id previously provided by spreadshirt
+  def self.find_by_spreadshirt_id(spreadshirt_id)
+    basket = where(:spreadshirt_id => spreadshirt_id).first
+
+    return nil unless basket
+
+    begin
+      SpreadshirtClient.get "/baskets/#{spreadshirt_id}", :authorization => true
+    rescue RestClient::ResourceNotFound
+      return nil
+    end
+
+    basket
+  end
+
+  private
+
+  # Create a spreadshirt basket with minimal payload
+  def create_spreadshirt_basket
+    xml = Builder::XmlMarkup.new
+    xml.instruct!
+
+    xml.basket :xmlns => "http://api.spreadshirt.net" do |basket|
+      basket.shop :id => $app_config.shop_id # Your shop id
+    end
+
+    self.spreadshirt_id = SpreadshirtClient.post("/baskets", xml.target!, :authorization => true).headers[:location].split("/").last
+  end
+end
+```
+
+Then, in your application, simply retrieve/create your customer's basket:
+
+```ruby
+def current_basket
+  return @current_basket if @current_basket
+
+  # Use spreadshirt's basket id stored in a cookie to retrieve the basket
+  @current_basket = Basket.find_by_spreadshirt_id(cookies[:spreadshirt_basket_id])
+  @current_basket ||= Basket.create! # Create the basket as it doesn't exist yet
+
+  cookies[:spreadshirt_basket_id] = @current_basket.spreadshirt_id
+
+  @current_basket
+end
+```
+
+## Resources
+
+Spreadshirt API Docs:
+- [Spreadshirt API Documentation](http://developer.spreadshirt.net/display/API/API)
+- [Spreadshirt API Documentation - Basket resource](http://developer.spreadshirt.net/display/API/Basket+Resources)
+- [Spreadshirt API Browser - DemoApp](http://demoapp.spreadshirt.net/apibrowser/)
+
+SpreadshirtClient uses the RestClient gem to send requests to the Spreadshirt API:
+- Take a look into the [RestClient gem documentation](https://github.com/rest-client/rest-client) to see how to handle the Spreadshirt API responses.
 
-Please take a look into the spreadshirt API docs for more details.
+Builder Docs:
+- [Github](https://github.com/jimweirich/builder)
+- [RDOCS](http://builder.rubyforge.org/)
 
 ## Contributing
 

data/lib/spreadshirt_client/version.rb

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

data/spreadshirt_client.gemspec

@@ -3,6 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 require "spreadshirt_client/version"
 
 Gem::Specification.new do |s|
+  s.license     = "MIT"
   s.name        = "spreadshirt_client"
   s.version     = SpreadshirtClient::VERSION
   s.authors     = ["Benjamin Vetter"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spreadshirt_client
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2013-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -77,7 +77,8 @@ files:
 - spreadshirt_client.gemspec
 - test/spreadshirt_client_test.rb
 homepage: https://github.com/mrkamel/spreadshirt_client
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: