dawanda_client 0.1.11 → 0.1.12

data/README.rdoc

@@ -1,43 +1,38 @@
-= Dawanda
+= DaWanda
 
-== Description
-
-The Dawanda gem provides a friendly Ruby interface to the Dawanda API
+The Dawanda gem provides a friendly Ruby interface to the Dawanda API, plus a secure {OAuth}[http://wiki.github.com/dawanda/dawanda-api-client-ruby/oauth] interface to get user-specific data.
 
 == Installation
  
 Installing the latest stable version is simple:
 
-    sudo gem install dawanda_client --source=http://gemcutter.org
+  sudo gem install dawanda_client
 
 == Usage
 
 The Dawanda API is read-only - all you need to gain access is an API Key (available 
 from http://dawanda.com/apps).  Once you have your API key, set it in your script:
 
-    require 'rubygems'
-    require 'dawanda'
-    Dawanda.api_key = 'foobar'
-    Dawanda.country = 'de'
+  require 'rubygems'
+  require 'dawanda'
+  Dawanda.api_key = 'foobar'
+  Dawanda.country = 'de'
 
 From there, you can make any calls to the API that you need. Note: Any call to the API can fail.
 In case of an error an exception is raised. So make sure your API client codes handles it.
 
-=== Users
-
-If you're starting with a user, the easiest way is to use the Dawanda.user method:
+See the {wiki}[http://wiki.github.com/dawanda/dawanda-api-client-ruby/] for more information about what you can recieve via the DaWanda API.
 
-    >> user = Dawanda.user('meko')
-    => #<Dawanda::User:0x141bf58 @result={"name"=>"meko", "city"=>"auma", "is_seller"=>true, ...
-    >> user.name
-    => "meko"
-    >> user.id
-    => 13008
+== Example
 
-For more information about what is available for a user, check out the documentation
-for Dawanda::User.
+If you're starting with a user, the easiest way is to use the Dawanda.user method:
 
-== Shops
+  >> user = Dawanda.get_user('meko')
+  => #<Dawanda::User:0x141bf58 @result={"name"=>"meko", "city"=>"auma", "is_seller"=>true, ...
+  >> user.name
+  => "meko"
+  >> user.id
+  => 13008
 
 Each user may optionally have a shop.  If a user is a seller, he / she also has an
 associated shop object:
@@ -48,50 +43,14 @@ associated shop object:
   => #<Dawanda::Shop:0x14170c0 @result={"is_vacation"=>false, "name"=>"MEKO STORE" ...
   >> shop.name
   => "MEKO STORE"
-  
-More information about shops can be found in the documentation for Dawanda::Shop.
-  
-== Products
-
-Dawanda::Shop, Dawanda::Category, Dawanda::Color contain multiple products:
-
-  >> shop.products
-  => [#<Dawanda::Product:0x1405f3c @result={"price"=>{"cents"=>2500, "currency_code"=>"EUR"}, "name"=>"Harmonie", ... ]
-  >> product = shop.products.first
-  => #<Dawanda::Product:0x1405f3c @result={"price"=>{"cents"=>2500, "currency_code"=>"EUR"}, "name"=>"Harmonie", ...
-  >> product.name
-  => "Harmonie"
-  >> product.description
-  => "Harmonie \n- Inselsymposium / Gimmlitztal \n- Eiche \n- geölt \n- L:150 / Durchmesser ca. 28cm"
-  >> product.product_url
-  => ""http://de.dawanda.com/product/1-Harmonie""
-  >> product.view_count
-  => 155
-  >> product.created_at
-  => Sat Sep 16 01:35:05 +0200 2006
-
-See the documentation for [Dawanda::Product|http://wiki.github.com/dawanda/dawanda-api/data-type-product] for more information.
-
-
-== Category
-
-Dawanda categories are organized in a tree. To get the top level of categories, you can call:
-
-  >> category = Dawanda::Category.top.first
-  => #<Dawanda::Category:0x138c5d8 @result={"product_count"=>0, "name"=>"2000", "id"=>218,
-  >> category.parent
-  => nil
-  >> category.children
-  => [#<Dawanda::Category:0x1395cb4 @result={"product_count"=>4851, "name"=>"2001", "id"=>222, ...
-  >> category.product_count
-  => 100
-
-== Exception
-
-  Chances are, that for some reason a HTTP request to the dawanda API can fail. This can have many reasons, either
-  missing network connection or a wrong id. In case the HTTP status code is different von 2xx or 3xx an exception containing
-  a meaningful error message is raised.
-  
+
+See the {wiki}[http://wiki.github.com/dawanda/dawanda-api-client-ruby/] for more information about what you can recieve via the DaWanda API.
+
+=== Exceptions
+
+Chances are, that for some reason a HTTP request to the dawanda API can fail. This can have many reasons, either
+missing network connection or a wrong id. In case the HTTP status code is different von 2xx or 3xx an exception containing
+a meaningful error message is raised.
+
   >> category = Dawanda::Category.find_by_id(2323)
   => RuntimeError: {"error":{"status":404,"message":"The Category 2323 could not be found"}}
-  

data/Rakefile

@@ -42,6 +42,8 @@ begin
     
     gemspec.files.exclude 'examples/*'
     gemspec.test_files.exclude 'examples/*'
+    
+    gemspec.add_dependency('oauth', '>= 0.3.7.pre1')
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"

data/VERSION

@@ -1 +1 @@
-0.1.11
+0.1.12

data/dawanda_client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dawanda_client}
-  s.version = "0.1.11"
+  s.version = "0.1.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["DaWanda GmbH"]
-  s.date = %q{2010-03-23}
+  s.date = %q{2010-03-26}
   s.description = %q{Provides a friendly ruby-like interface to the Dawanda API}
   s.email = %q{api@dawanda.com}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "lib/dawanda/channel.rb",
      "lib/dawanda/color.rb",
      "lib/dawanda/model.rb",
+     "lib/dawanda/oauth.rb",
      "lib/dawanda/pinboard.rb",
      "lib/dawanda/product.rb",
      "lib/dawanda/request.rb",
@@ -69,9 +70,12 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<oauth>, [">= 0.3.7.pre1"])
     else
+      s.add_dependency(%q<oauth>, [">= 0.3.7.pre1"])
     end
   else
+    s.add_dependency(%q<oauth>, [">= 0.3.7.pre1"])
   end
 end
 

data/lib/dawanda/oauth.rb

@@ -0,0 +1,52 @@
+module Dawanda
+  
+  # = OAuth
+  #
+  # Provides access to sesitive user data
+  
+  class OAuth
+    API_PREFIX = '/api/v1/oauth'
+    
+    def self.connect key, secret
+      @@consumer = Dawanda::OAuth.create_consumer key, secret
+      @@request_token = @@consumer.get_request_token  
+    end
+    
+    def self.rebuild key, secret, params
+      @@consumer = Dawanda::OAuth.create_consumer key, secret
+      @@request_token = ::OAuth::RequestToken.from_hash(@@consumer, params) 
+      @@request_token.consumer.options.merge!({:oauth_verifier => params[:oauth_verifier]})
+      @@access_token = @@request_token.get_access_token
+    end
+    
+    def self.authorize_url
+      @@request_token.authorize_url
+    end
+    
+    def self.access_token
+      @@access_token ||= nil
+    end
+
+    def self.access_token=(access_token)
+      @@access_token = access_token
+    end
+
+    def self.get(url, options={})
+      Dawanda::Response.new(@@access_token.get(url).body)
+    end
+
+    def self.user
+      Dawanda::User.new(Dawanda::OAuth.get("#{API_PREFIX}/users.json").result)
+    end
+    
+  private
+    def self.create_consumer key, secret
+      @@consumer = ::OAuth::Consumer.new(key, secret, {
+        :site               => "http://#{Dawanda.country}.#{Dawanda.domain}",
+        :request_token_path => "/oauth/request_token",
+        :access_token_path  => "/oauth/access_token",
+        :authorize_path     => "/oauth/authorize"
+      })
+    end
+  end
+end

data/lib/dawanda.rb

@@ -4,6 +4,9 @@ require 'net/http'
 require 'json'
 require 'time'
 
+gem 'oauth', '>=0.3.7.pre1'
+require 'oauth'
+
 require 'dawanda/request'
 require 'dawanda/response'
 
@@ -17,6 +20,8 @@ require 'dawanda/color'
 require 'dawanda/channel'
 require 'dawanda/pinboard'
 
+require 'dawanda/oauth'
+
 # = DaWanda Client: A friendly Ruby interface to the DaWanda API
 #
 # == Quick Start
@@ -123,4 +128,4 @@ module Dawanda
     Pinboard.find_by_id(pinboard_id)
   end
   
-end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 11
-  version: 0.1.11
+  - 12
+  version: 0.1.12
 platform: ruby
 authors: 
 - DaWanda GmbH
@@ -14,10 +14,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-23 00:00:00 +01:00
+date: 2010-03-26 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 7
+        - pre1
+        version: 0.3.7.pre1
+  type: :runtime
+  version_requirements: *id001
 description: Provides a friendly ruby-like interface to the Dawanda API
 email: api@dawanda.com
 executables: []
@@ -39,6 +53,7 @@ files:
 - lib/dawanda/channel.rb
 - lib/dawanda/color.rb
 - lib/dawanda/model.rb
+- lib/dawanda/oauth.rb
 - lib/dawanda/pinboard.rb
 - lib/dawanda/product.rb
 - lib/dawanda/request.rb