lomadee_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ab7f1c361d667781cf3231c06c001319ac0dea3
-  data.tar.gz: 3cfac6d9d652b81a922b566a50e705ec01117ab5
+  metadata.gz: d204aa65e075f0fb77e54664c34b9143ab0b7294
+  data.tar.gz: 042643ea85d114474c18cde383c013283523390c
 SHA512:
-  metadata.gz: fe880e88160b2057075d70946ae1f2563faec5e24e61d5041b9339cb637088cd7cb6739630066cd3e5224e693554cda97208339ff6313406b7df97eec8dfde73
-  data.tar.gz: c2f77325a2d7a9a72a6d817a1ffc0d39291a89547dc9818b93575f074ebc089dc4edbdd9abffca7cfa872fc8b90160e33d4dc13fa2f3369e5d5a0b4f1e548c5d
+  metadata.gz: a8982940d5e8dd0fda72f9778e0ba944b65f06fd40c887c2e5ad3e76f6bdef39d1a7e8ca2d0dc67aa93f80b79a1010f1cb0d4f7b1a6f3be7666210f66e2632b9
+  data.tar.gz: c2e767363637e7d4d16fb03a3918edccd4f1c47b6a7afeabc9c0e7f2577353b8b9969973b70a0d6c6a75a8025e713b95d2f5dae9fe9b093dd6392ad5922bd230

data/README.md

@@ -1,6 +1,6 @@
 # LomadeeApi
 
-TODO: Write a gem description
+A Ruby client for the official Lomadee API.
 
 ## Installation
 
@@ -16,9 +16,55 @@ Or install it yourself as:
 
     $ gem install lomadee_api
 
-## Usage
+## Configuration
 
-TODO: Write usage instructions here
+To start using the gem, you can instantiate a new Base object from LomadeeApi module with three configuration options (application_id, sandbox and country)
+
+```ruby
+lomadee = LomadeeApi::Base.new(application_id: 'YOUR_APPLICATION_ID', sandbox: true)
+```
+
+The following table shows which options are accepted and its default values.
+
+| Options | Values |
+|----------------|-----------------------------------------------------------------------------------------------------------------------------|
+| application_id | Encrypted ID that is generated when you create a lomadee application |
+| country | "BR" (Brazil), "AR" (Argentina), "CO" (Colombia), "CL" (Chile), "MX" (Mexico), "PE" (Peru), "VE" (Venezuela), default: "BR" |
+| sandbox | true/false, default: false |
+
+## Usage Examples
+
+After configuring a lomadee object, you can do the following things.
+
+### Get all products from a given category id
+
+```ruby
+lomadee = LomadeeApi::Base.new(application_id: 'YOUR_APPLICATION_ID')
+category_products = []
+
+lomadee.products(77) do |products|
+    products.each do |product|
+        category_products << product['product']
+    end
+end
+
+puts category_products.count
+```
+
+### Get all offers from a given product id
+
+```ruby
+lomadee = LomadeeApi::Base.new(application_id: 'YOUR_APPLICATION_ID')
+product_offers = []
+
+lomadee.offers(572767) do |offers|
+    offers.each do |offer|
+        product_offers << offer['offer']
+    end
+end
+
+puts product_offers.count
+```
 
 ## Contributing
 
@@ -26,4 +72,4 @@ TODO: Write usage instructions here
 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 a new Pull Request
+5. Create a new Pull Request

data/lib/lomadee_api.rb

@@ -1,7 +1,7 @@
 require 'httparty'
 require 'json'
-require 'lomadee_api/version'
 require 'lomadee_api/base'
+require 'lomadee_api/version'
 
 module LomadeeApi
 end

data/lib/lomadee_api/base.rb

@@ -0,0 +1,50 @@
+module LomadeeApi
+  class Base
+    include HTTParty
+
+    def initialize(params = {})
+      raise "You need to inform your :application_id" if params[:application_id].nil?
+
+      @application_id = params[:application_id]
+      @country = params[:country] || 'BR'
+
+      sandbox = params[:sandbox] || false
+
+      case sandbox
+      when false
+        self.class.base_uri "http://bws.buscape.com"
+      else
+        self.class.base_uri "http://sandbox.buscape.com"
+      end
+
+    end
+
+    def products(category_id)
+      @page = @totalpages = 1
+
+      while @page <= @totalpages
+        products = self.class.get("/service/findProductList/lomadee/#{@application_id}/#{@country}/", query: {categoryId: category_id, format: 'json', page: @page})
+        
+        @response = JSON.parse(products.body)
+        @totalpages = @response['totalpages']
+        @page += 1
+
+        yield @response['product']
+      end
+    end
+
+    def offers(product_id)
+      @page = @totalpages = 1
+
+      while @page <= @totalpages
+        offers = self.class.get("/service/findOfferList/lomadee/#{@application_id}/#{@country}/", query: {productId: product_id, format: 'json', page: @page})
+
+        @response = JSON.parse(offers.body)
+        @totalpages = @response['totalpages']
+        @page += 1
+
+        yield @response['offer']
+      end
+    end
+  end
+end

data/lib/lomadee_api/version.rb

@@ -1,3 +1,3 @@
 module LomadeeApi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lomadee_api.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = LomadeeApi::VERSION
   spec.authors       = ["Guilherme Kenedy Ferreira"]
   spec.email         = ["guilhermekfe@outlook.com"]
-  spec.summary       = %q{Gem to wrap lomadee.com API}
-  spec.description   = %q{Gem to wrap lomadee.com API}
+  spec.summary       = %q{ Ruby client for the official Lomadee API }
+  spec.description   = %q{ Ruby client for the official Lomadee API }
   spec.homepage      = ""
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lomadee_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Guilherme Kenedy Ferreira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Gem to wrap lomadee.com API
+description: " Ruby client for the official Lomadee API "
 email:
 - guilhermekfe@outlook.com
 executables: []
@@ -79,6 +79,7 @@ files:
 - README.md
 - Rakefile
 - lib/lomadee_api.rb
+- lib/lomadee_api/base.rb
 - lib/lomadee_api/version.rb
 - lomadee_api.gemspec
 homepage: ''
@@ -104,5 +105,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Gem to wrap lomadee.com API
+summary: Ruby client for the official Lomadee API
 test_files: []