dawanda_client 0.1.6

data/.gitignore

@@ -0,0 +1,2 @@
+doc
+pkg

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Christoph Bünte (info@christophbuente.de)
+
+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.rdoc

@@ -0,0 +1,97 @@
+= Dawanda
+
+== Description
+
+The Dawanda gem provides a friendly Ruby interface to the Dawanda API
+
+== Installation
+ 
+Installing the latest stable version is simple:
+
+    sudo gem install dawanda-dawanda_client --source=http://gems.github.com
+
+== 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'
+
+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:
+
+    >> user = Dawanda.user('meko')
+    => #<Dawanda::User:0x141bf58 @result={"name"=>"meko", "city"=>"auma", "is_seller"=>true, ...
+    >> user.name
+    => "meko"
+    >> user.id
+    => 13008
+
+For more information about what is available for a user, check out the documentation
+for Dawanda::User.
+
+== Shops
+
+Each user may optionally have a shop.  If a user is a seller, he / she also has an
+associated shop object:
+
+  >> user.seller?
+  => true
+  >> shop = user.shop
+  => #<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.
+  
+  >> category = Dawanda::Category.find_by_id(2323)
+  => RuntimeError: {"error":{"status":404,"message":"The Category 2323 could not be found"}}
+  

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+task :default => :test
+
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+namespace :doc do
+
+  desc 'generate doc'
+  task :generate do
+    `rdoc`
+  end
+  
+  desc 'clean up all docs'
+  task :clean do
+    `rm -fr doc`
+  end
+  
+  desc 'open docs in browser'
+  task :open do
+    `open doc/index.html`
+  end
+end
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "dawanda_client"
+    gemspec.summary = "Provides a friendly ruby-like interface to the Dawanda API"
+    gemspec.description = "Describe your gem"
+    gemspec.email = 'info@christophbuente.de'
+    gemspec.homepage = "http://github.com/dawanda/dawanda_client"
+    gemspec.authors = ['Christoph Bünte']
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.6

data/dawanda_client.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dawanda_client}
+  s.version = "0.1.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph B\303\274nte"]
+  s.date = %q{2009-10-13}
+  s.description = %q{Describe your gem}
+  s.email = %q{info@christophbuente.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "dawanda_client.gemspec",
+     "lib/dawanda.rb",
+     "lib/dawanda/category.rb",
+     "lib/dawanda/channel.rb",
+     "lib/dawanda/color.rb",
+     "lib/dawanda/model.rb",
+     "lib/dawanda/product.rb",
+     "lib/dawanda/request.rb",
+     "lib/dawanda/response.rb",
+     "lib/dawanda/shop.rb",
+     "lib/dawanda/shop_category.rb",
+     "lib/dawanda/user.rb",
+     "test/fixtures/getCategoryDetails.json",
+     "test/fixtures/getProductDetails.json",
+     "test/fixtures/getShopDetails.json",
+     "test/fixtures/getUserDetails.json",
+     "test/test_helper.rb",
+     "test/unit/dawanda/category_test.rb",
+     "test/unit/dawanda/color_test.rb",
+     "test/unit/dawanda/product_test.rb",
+     "test/unit/dawanda/shop_category_test.rb",
+     "test/unit/dawanda/shop_test.rb",
+     "test/unit/dawanda/user_test.rb",
+     "test/unit/dawanda_test.rb"
+  ]
+  s.homepage = %q{http://github.com/dawanda/dawanda_client}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Provides a friendly ruby-like interface to the Dawanda API}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/unit/dawanda/category_test.rb",
+     "test/unit/dawanda/color_test.rb",
+     "test/unit/dawanda/product_test.rb",
+     "test/unit/dawanda/shop_category_test.rb",
+     "test/unit/dawanda/shop_test.rb",
+     "test/unit/dawanda/user_test.rb",
+     "test/unit/dawanda_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/dawanda.rb

@@ -0,0 +1,99 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'net/http'
+require 'json'
+require 'time'
+
+require 'dawanda/request'
+require 'dawanda/response'
+
+require 'dawanda/model'
+require 'dawanda/user'
+require 'dawanda/shop'
+require 'dawanda/product'
+require 'dawanda/category'
+require 'dawanda/shop_category'
+require 'dawanda/color'
+require 'dawanda/channel'
+
+# = DaWanda Client: A friendly Ruby interface to the DaWanda API
+#
+# == Quick Start
+# 
+# Getting started is easy.  First, you will need a valid API key from the Dawanda 
+# developer site (http://dawanda.com/apps).  Since the API is read-only at
+# the moment, that's all you need to do.
+# 
+# To start using the API, require the dawanda gem and set it up to use your API key:
+# 
+#     require 'rubygems'
+#     require 'dawanda'
+#     
+#     Dawanda.api_key = 'itsasecret'
+#     
+# Now you can make API calls that originate from an Dawanda user:
+# 
+#     # Find a user by username
+#     user = Dawanda.user('meko')
+#     
+#     # Grab that user's shop information
+#     user.seller?
+#     user.shop
+#     user.shop.title
+#     
+#     # ... and the products in the shop
+#     product = user.shop.products.first
+#     product.title
+#     product.description
+#     
+# To see what else is available for a user, check out the full documentation for
+# the Dawanda::User class.
+#
+module Dawanda
+ 
+  # Set the API key for all requests
+  def self.api_key=(api_key)
+    @api_key = api_key
+  end
+  
+  # Retrieve the API key
+  def self.api_key
+    @api_key
+  end
+  
+  # Set the country for all requests
+  def self.country=(country)
+    @country = country
+  end
+  
+  # Retrieve the country
+  def self.country
+    @country || 'de'
+  end
+  
+  # Find a user by username.  See Dawanda::User for more information.
+  def self.user(username_or_id)
+    User.find_by_user_id(username_or_id)
+  end
+  
+  # Find a shop by username.  See Dawanda::Shop for more information.
+  def self.shop(username_or_id)
+    Shop.find_by_user_id(username_or_id)
+  end
+  
+  # Find a product by id.  See Dawanda::Product for more information.
+  def self.product(product_id)
+    Product.find_by_id(product_id)
+  end
+  
+  # Find a category by id.  See Dawanda::Category for more information.
+  def self.category(category_id)
+    Category.find_by_id(category_id)
+  end
+  
+  # Find a shop_category by id.  See Dawanda::ShopCategory for more information.
+  def self.shop_category(shop_category_id)
+    ShopCategory.find_by_id(shop_category_id)
+  end
+  
+end

data/lib/dawanda/category.rb

@@ -0,0 +1,47 @@
+module Dawanda
+  
+  # = Category
+  #
+  # Dawanda::Category are organized in a tree. To get the top level categories call top
+  #
+  # Represents a single Dawanda::Category - has the following attributes:
+  #
+  # [id] The unique identifier for this category
+  # [parent_id] This category's parent id
+  # [name] This category's name 
+  # [product_count] The amount of products in this category
+  #
+  class Category
+    
+    include Dawanda::Model
+    
+    finder :all, '/categories/:name'
+    finder :all, '/categories/:parent_id/children'
+    finder :all, '/channels/:channel_id/categories'
+    finder :one, '/categories/:id'
+    
+    attributes :id, :parent_id, :name, :product_count
+    
+    # Get all products for this category.
+    def products(params = {})
+      @products ||= Product.find_all_by_category_id(id, params)
+    end
+    
+    # Get all the top level categories.
+    def self.top(params = {})
+      # This is a hack, because dynamic finder generation takes at least
+      # one placeholder like ":name"
+      self.find_all_by_name('top', params)
+    end
+    
+    # Get all child categories of this category
+    def children(params = {})
+      Category.find_all_by_parent_id(id, params)
+    end
+
+    # Get the parent category of this category
+    def parent(params = {})
+      (parent_id and parent_id !=0) ? Category.find_by_id(parent_id, params) : nil
+    end
+  end
+end

data/lib/dawanda/channel.rb

@@ -0,0 +1,26 @@
+module Dawanda
+  
+  # = Channel
+  #
+  # Dawanda::Channel are a top hierachy to categories.
+  #
+  # Represents a single Dawanda::Channel - has the following attributes:
+  #
+  # [id] The unique identifier for this channel
+  # [name] This channels's name 
+  # [categories] The categories that belong to this channel
+  #
+  class Channel
+    
+    include Dawanda::Model
+
+    finder :one, '/channels/:channel_id'
+    
+    attributes :id, :name
+    
+    # Get all categories for this channel.
+    def categories(params = {})
+      @categories ||= Category.find_all_by_channel_id(id, params)
+    end
+  end
+end

data/lib/dawanda/color.rb

@@ -0,0 +1,23 @@
+module Dawanda
+  
+  # = Color
+  #
+  # Represents a single Color - has the following attributes:
+  #
+  # [hex] This color's hex value
+  # [red] The color's red value from 0-255
+  # [green] The color's green value from 0-255
+  # [blue] The color's blue value from 0-255
+  #
+  class Color
+    
+    include Dawanda::Model
+    
+    attributes :hex, :red, :green, :blue
+    
+    def products(params = {})
+      Product.find_all_by_hex(hex, params)
+    end
+    
+  end
+end