buscape_api 0.5

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+ 
+gem 'httparty'
+ 
+group :test do
+  gem 'webmock'
+  gem 'vcr'
+  gem 'turn'
+  gem 'rake'
+  gem 'require_all'
+  gem 'minitest'
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    ansi (1.4.3)
+    crack (0.3.1)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    minitest (3.2.0)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    rake (0.9.2.2)
+    require_all (1.2.1)
+    turn (0.9.6)
+      ansi
+    vcr (2.2.2)
+    webmock (1.8.7)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty
+  minitest
+  rake
+  require_all
+  turn
+  vcr
+  webmock

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |t|
+  t.test_files = FileList.new('spec/lib/buscape_api/*_spec.rb')
+  t.verbose = true
+end
+ 
+task :default => :test

data/Readme.rdoc

@@ -0,0 +1,51 @@
+= Buscape API
+
+== Instalation
+
+  gem install buscape_api
+
+== Usage
+
+First require the gem:
+
+  require 'buscape_api'
+
+Then instantiate the Buscape class
+
+  buscape = Buscape.new(:app_id => 'your_app_key')
+
+The Buscape class takes also two optional parameters which are *:sandbox*(should be true) and *:country_code*(check about it's usage at http://developer.buscape.com/api/)
+
+An example using all the parameters is:
+
+  buscape = Buscape.new(:app_id => 'your_app_key', :country_code => 'BR', :sandbox => true)
+
+Now you have the following methods to be used with your object:
+
+* categories
+* products
+* offers
+* top_products
+* user_ratings
+* product_details
+* seller_details
+
+After that, use the where method passing the parameters(follow http://developer.buscape.com/api/ parameters usage).
+
+===Example:
+
+  require 'buscape_api'
+
+  buscape = Buscape.new(:app_id => '12345', :sandbox => true)
+
+  buscape.products.where(:categoryId => 77) # Returns all products of category 77 in array/hash style.
+
+  buscape.top_products.where(:keyword => 'Celular') # Returns all top products that is a Celular
+
+== Contributing
+
+Feel free to submit any ideas, issues or pull requests. If you have the time, write some tests/docs(should be simple) for it.
+
+=== Contributors
+
+None yet.

data/buscape_api.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "buscape_api"
+  s.version     = "0.5"
+  s.email       = ["t@art-is-t.me"]
+  s.authors     = ["Thiago Fernandes Massa"]
+  s.homepage    = "http://github.com/thiagofm/buscape_api"
+  s.summary     = %q{Buscape API wrapper}
+  s.description = %q{A Buscape API wrapper}
+
+  s.rubyforge_project = "buscape_api"
+
+  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_dependency("httparty", ">= 0.8.3")
+end

data/lib/buscape_api.rb

@@ -0,0 +1,14 @@
+require "require_all"
+
+# Loading and requiring all api files
+require_all 'lib/buscape_api'
+
+class Buscape
+  def initialize(options = {})
+    @options = options 
+  end
+
+  def method_missing(method, *args)
+    Base.new(@options).send(method, args.first)
+  end
+end

data/lib/buscape_api/base.rb

@@ -0,0 +1,63 @@
+require 'httparty'
+
+class Base
+  include HTTParty
+
+  def initialize(options = {})
+    raise "No :app_id set" unless options.include? :app_id
+    options[:format] = 'json' # JSON is more lightweight than xml
+    @options = options
+    @services = [
+      { :method => :categories, :service => :findCategoryList },
+      { :method => :products, :service => :findProductList },
+      { :method => :offers, :service => :findOffersList, :item => :offer },
+      { :method => :top_products, :service => :topProducts },
+      { :method => :user_ratings, :service => :viewUserRatings },
+      { :method => :product_details, :service => :viewProductDetailst },
+      { :method => :seller_details, :service => :viewSellerDetails }
+    ]
+    @methods = @services.map { |service| service[:method] }
+    @url = base_url
+  end
+  
+  def base_url
+    @options[:sandbox] ? "http://sandbox.buscape.com" : "http://bws.buscape.com"
+  end
+
+  def select_service(method)
+    @services.each do |s|
+      @service = s[:service] if s.values.include? method
+    end
+    @url << '/service/' << @service.to_s
+  end
+
+  def set_app_id
+    @url << '/' << @options[:app_id]
+  end
+
+  def select_country
+    @url << '/' << @options[:country_code]
+  end
+ 
+  def parameterize(options)
+    parameters = String.new
+
+    options.keys.each_with_index do |parameter,index|
+      index == 0 ? @url << "/?#{parameter}=#{options[parameter]}" : @url << "&#{parameter}=#{options[parameter]}"
+    end
+  end
+
+  def method_missing(method, *args)
+    if @methods.include? method
+      select_service method
+      set_app_id
+      select_country if @options.include? :country_code
+      self
+    elsif method == :where
+      parameterize args.first
+      response = self.class.get(@url)['Result']
+    else
+      raise NoMethodError
+    end
+  end
+end

data/spec/lib/buscape_api/base_spec.rb

@@ -0,0 +1,9 @@
+require (File.expand_path('./../../../spec_helper', __FILE__))
+ 
+describe Buscape::Base do
+ 
+  it "must work" do
+    "Yay!".must_be_instance_of String
+  end
+ 
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# require dependancies
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'vcr'
+require 'turn'
+require 'ap'
+require 'require_all'
+
+# require lib 
+require_all 'lib/'
+
+Turn.config do |c|
+ c.format  = :outline
+ c.trace   = true
+ c.natural = true
+end
+ 
+VCR.config do |c|
+  c.cassette_library_dir = 'spec/fixtures/buscape_api'
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: buscape_api
+version: !ruby/object:Gem::Version
+  version: '0.5'
+  prerelease: 
+platform: ruby
+authors:
+- Thiago Fernandes Massa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2157367040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157367040
+description: A Buscape API wrapper
+email:
+- t@art-is-t.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.rdoc
+- buscape_api.gemspec
+- lib/buscape_api.rb
+- lib/buscape_api/base.rb
+- spec/lib/buscape_api/base_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/thiagofm/buscape_api
+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: buscape_api
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Buscape API wrapper
+test_files:
+- spec/lib/buscape_api/base_spec.rb
+- spec/spec_helper.rb