mercadolibre 0.14.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b5c5f27ea71eee142b1c096919f2032c0b6eaf0
-  data.tar.gz: d48d5f815c342ff5eb2df25194453f72456f04ea
+  metadata.gz: 18de3ede412fce4880cacc3968f4fb9ea4958b00
+  data.tar.gz: 3c7f5ca25da212c014f52c613f683fd6541f91af
 SHA512:
-  metadata.gz: 261558d0ce71558dff79d915e1cb7a718c708a12b3f157ca22f2537da62e0b4474189dc399544e5ce8e6a40cfd043342798218d6f6b39a8672950f6861fd6290
-  data.tar.gz: 3bef58f55076619f512580988e290bc9a34bb3591b3221269e2dcafcc7ff191b57a6948d7228d136c881a7aa7ab1461b49f2ceb78f68b2048a3366eb441086ba
+  metadata.gz: c03b1318cf281ef41560730cef0e8a39843bc66719b08f7807f777724214d41a853ccb8358a20abc8a8e24960870fbc1b104a78ccbab8823b8c0f8f4a906e09b
+  data.tar.gz: 5fa91775520a8e2b4d8cb55e0971e5ebcf889fc355fc7ab7f406c901680e614d5c29b46367578f324d02e3a29d84ec1157c0aea01c8a716db97b130bf22f1206

data/CHANGELOG.md

@@ -229,3 +229,7 @@
 ## v0.14.1
 
 * Added order entity for mercadopago
+
+## v1.0.0
+
+* Full redesign for API, added messaging methods

data/lib/mercadolibre.rb

@@ -1,97 +1,19 @@
 require "mercadolibre/version"
 
-# mercadolibre -> entities
-require "mercadolibre/entity/address"
-require "mercadolibre/entity/address_agency"
-require "mercadolibre/entity/answer"
-require "mercadolibre/entity/atm_transfer_reference"
-require "mercadolibre/entity/auth"
-require "mercadolibre/entity/billing_info"
-require "mercadolibre/entity/card_configuration"
-require "mercadolibre/entity/card_issuer"
-require "mercadolibre/entity/category"
-require "mercadolibre/entity/category_settings"
-require "mercadolibre/entity/city"
-require "mercadolibre/entity/collector"
-require "mercadolibre/entity/cost_components"
-require "mercadolibre/entity/country"
-require "mercadolibre/entity/currency"
-require "mercadolibre/entity/currency_conversion_ratio"
-require "mercadolibre/entity/featured_item"
-require "mercadolibre/entity/feedback"
-require "mercadolibre/entity/feedback_reply"
-require "mercadolibre/entity/geolocation"
-require "mercadolibre/entity/gtin"
-require "mercadolibre/entity/item"
-require "mercadolibre/entity/item_attribute"
-require "mercadolibre/entity/item_description"
-require "mercadolibre/entity/item_payment_method"
-require "mercadolibre/entity/item_picture"
-require "mercadolibre/entity/item_shipping"
-require "mercadolibre/entity/listing_exposure"
-require "mercadolibre/entity/listing_price"
-require "mercadolibre/entity/listing_type"
-require "mercadolibre/entity/mediation"
-require "mercadolibre/entity/mediation_interaction"
-require "mercadolibre/entity/municipality"
-require "mercadolibre/entity/neighborhood"
-require "mercadolibre/entity/order"
-require "mercadolibre/entity/order_coupon"
-require "mercadolibre/entity/order_feedback"
-require "mercadolibre/entity/order_item"
-require "mercadolibre/entity/order_note"
-require "mercadolibre/entity/order_shipping"
-require "mercadolibre/entity/payment"
-require "mercadolibre/entity/payment_method"
-require "mercadolibre/entity/payment_plan"
-require "mercadolibre/entity/payment_promotion"
-require "mercadolibre/entity/phone"
-require "mercadolibre/entity/product_identifier"
-require "mercadolibre/entity/question"
-require "mercadolibre/entity/search_location"
-require "mercadolibre/entity/shipment"
-require "mercadolibre/entity/shipment_status_history"
-require "mercadolibre/entity/shipping_delivery"
-require "mercadolibre/entity/shipping_item"
-require "mercadolibre/entity/shipping_option"
-require "mercadolibre/entity/shipping_speed"
-require "mercadolibre/entity/site"
-require "mercadolibre/entity/site_domain"
-require "mercadolibre/entity/site_trend"
-require "mercadolibre/entity/state"
-require "mercadolibre/entity/user"
-require "mercadolibre/entity/zip_code"
-
 # mercadolibre -> core
 require "mercadolibre/core/auth"
 require "mercadolibre/core/categories_and_listings"
+require "mercadolibre/core/collections"
 require "mercadolibre/core/items_and_searches"
 require "mercadolibre/core/locations_and_currencies"
 require "mercadolibre/core/order_management"
-require "mercadolibre/core/shippings"
 require "mercadolibre/core/questions"
+require "mercadolibre/core/shippings"
 require "mercadolibre/core/users"
 
 # mercadolibre -> api
 require "mercadolibre/api"
 
-# mercadopago -> entities
-require "mercadopago/entity/additional_info"
-require "mercadopago/entity/address"
-require "mercadopago/entity/auth"
-require "mercadopago/entity/collector"
-require "mercadopago/entity/fee_detail"
-require "mercadopago/entity/identification"
-require "mercadopago/entity/money_request"
-require "mercadopago/entity/order"
-require "mercadopago/entity/payer"
-require "mercadopago/entity/payment"
-require "mercadopago/entity/phone"
-require "mercadopago/entity/refund"
-require "mercadopago/entity/shipments"
-require "mercadopago/entity/source"
-require "mercadopago/entity/transaction_details"
-
 # mercadopago -> core
 require "mercadopago/core/auth"
 require "mercadopago/core/payments"
@@ -103,3 +25,5 @@ require "mercadopago/api"
 require 'rest-client'
 require 'singleton'
 require 'time'
+require 'json'
+require 'ostruct'

data/lib/mercadolibre/api.rb

@@ -9,12 +9,12 @@ module Mercadolibre
       @access_token = args[:access_token]
       @endpoint_url = 'https://api.mercadolibre.com'
       @auth_url = 'https://auth.mercadolibre.com.ar'
-      @debug = args[:debug]
       @site = args[:site]
     end
 
     include Mercadolibre::Core::Auth
     include Mercadolibre::Core::CategoriesAndListings
+    include Mercadolibre::Core::Collections
     include Mercadolibre::Core::ItemsAndSearches
     include Mercadolibre::Core::LocationsAndCurrencies
     include Mercadolibre::Core::OrderManagement
@@ -22,64 +22,100 @@ module Mercadolibre
     include Mercadolibre::Core::Shippings
     include Mercadolibre::Core::Users
 
+    def get_last_response
+      @last_response
+    end
+
     private
 
     def get_request(action, params={}, headers={})
       begin
-        parse_response(RestClient.get("#{@endpoint_url}#{action}", {params: params}.merge(headers)))
+        api_response_kind = params.delete('api_response_kind')
+        api_response_kind = params.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.get("#{@endpoint_url}#{action}", {params: params}.merge(headers)))
       rescue => e
-        parse_response(e.response)
+        parse_response('object', e.response)
       end
     end
 
     def post_request(action, params={}, headers={})
       begin
-        parse_response(RestClient.post("#{@endpoint_url}#{action}", params, headers))
+        api_response_kind = params.delete('api_response_kind')
+        api_response_kind = params.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.post("#{@endpoint_url}#{action}", params, headers))
       rescue => e
-        parse_response(e.response)
+        parse_response('object', e.response)
       end
     end
 
     def put_request(action, params={}, headers={})
       begin
-        parse_response(RestClient.put("#{@endpoint_url}#{action}", params, headers))
+        api_response_kind = params.delete('api_response_kind')
+        api_response_kind = params.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.put("#{@endpoint_url}#{action}", params, headers))
       rescue => e
-        parse_response(e.response)
+        parse_response('object', e.response)
       end
     end
 
     def patch_request(action, params={}, headers={})
       begin
-        parse_response(RestClient.patch("#{@endpoint_url}#{action}", params, headers))
+        api_response_kind = params.delete('api_response_kind')
+        api_response_kind = params.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.patch("#{@endpoint_url}#{action}", params, headers))
       rescue => e
-        parse_response(e.response)
+        parse_response('object', e.response)
       end
     end
 
     def head_request(action, params={})
       begin
-        parse_response(RestClient.head("#{@endpoint_url}#{action}", params))
+        api_response_kind = params.delete('api_response_kind')
+        api_response_kind = params.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.head("#{@endpoint_url}#{action}", params))
       rescue => e
-        parse_response(e.response)
+        parse_response('object', e.response)
       end
     end
 
     def delete_request(action, params={})
       begin
-        parse_response(RestClient.delete("#{@endpoint_url}#{action}", params))
+        api_response_kind = params.delete('api_response_kind')
+        api_response_kind = params.delete(:api_response_kind) if api_response_kind.nil?
+        api_response_kind = 'object' if api_response_kind.nil?
+
+        parse_response(api_response_kind, RestClient.delete("#{@endpoint_url}#{action}", params))
       rescue => e
-        parse_response(e.response)
+        parse_response('object', e.response)
       end
     end
 
-    def parse_response(response)
-      result = {
-        headers: response.headers,
-        body: (JSON.parse(response.body) rescue response.body),
-        status_code: response.code
-      }
+    def parse_response(api_response_kind, response)
+      @last_response = response
 
-      p "DEBUG: #{result}" if @debug
+      result = OpenStruct.new
+      result.status_code = response.code
+
+      if api_response_kind == 'object'
+        result.headers = (JSON.parse(response.headers.to_json, object_class: OpenStruct) rescue response.headers)
+        result.body = (JSON.parse(response.body, object_class: OpenStruct) rescue response.body)
+      elsif api_response_kind == 'hash'
+        result.headers = response.headers
+        result.body = (JSON.parse(response.body) rescue response.body)
+      else
+        result.headers = response.headers
+        result.body = response.body
+      end
 
       result
     end

data/lib/mercadolibre/core/auth.rb

@@ -18,13 +18,11 @@ module Mercadolibre
           client_secret: @app_secret,
           code: auth_code,
           redirect_uri: @callback_url
-        })[:body]
+        })
 
-        @access_token = response['access_token']
-
-        Mercadolibre::Entity::Auth.new(response.merge({
-          expired_at: (Time.now + response['expires_in'].to_i)
-        }))
+        @access_token = response.body.access_token
+        response.body.expiration_time = (Time.now + response.body.expires_in.to_i)
+        response.body
       end
 
       def update_token(refresh_token)
@@ -33,13 +31,11 @@ module Mercadolibre
           client_id: @app_key,
           client_secret: @app_secret,
           refresh_token: refresh_token
-        })[:body]
-
-        @access_token = response['access_token']
+        })
 
-        Mercadolibre::Entity::Auth.new(response.merge({
-          expired_at: (Time.now + response['expires_in'].to_i)
-        }))
+        @access_token = response.body.access_token
+        response.body.expiration_time = (Time.now + response.body.expires_in.to_i)
+        response.body
       end
     end
   end

data/lib/mercadolibre/core/categories_and_listings.rb

@@ -2,54 +2,38 @@ module Mercadolibre
   module Core
     module CategoriesAndListings
       def get_sites
-        results = get_request('/sites')
-
-        results[:body].map { |r| Mercadolibre::Entity::Site.new(r) }
+        get_request('/sites').body
       end
 
       def get_site(site_id)
-        result = get_request("/sites/#{site_id}")
-
-        Mercadolibre::Entity::Site.new(result[:body])
+        get_request("/sites/#{site_id}").body
       end
 
       def get_site_domain_info(domain)
-        result = get_request("/site_domains/#{domain}")
-
-        Mercadolibre::Entity::SiteDomain.new(result[:body])
+        get_request("/site_domains/#{domain}").body
       end
 
       def get_listing_types(site_id)
-        results = get_request("/sites/#{site_id}/listing_types")
-
-        results[:body].map { |r| Mercadolibre::Entity::ListingType.new(r) }
+        get_request("/sites/#{site_id}/listing_types").body
       end
 
       def get_listing_exposures(site_id)
-        results = get_request("/sites/#{site_id}/listing_exposures")
-
-        results[:body].map { |r| Mercadolibre::Entity::ListingExposure.new(r) }
+        get_request("/sites/#{site_id}/listing_exposures").body
       end
 
       def get_listing_prices(filters)
         valid_filters = ['price', 'listing_type_id', 'quantity', 'category_id', 'currency_id']
         filters.keep_if { |k,v| valid_filters.include?(k.to_s) }
 
-        results = get_request("/sites/#{site_id}/listing_prices", filters)
-
-        results[:body].map { |r| Mercadolibre::Entity::ListingPrice.new(r) }
+        get_request("/sites/#{site_id}/listing_prices", filters).body
       end
 
       def get_site_categories(site_id)
-        results = get_request("/sites/#{site_id}/categories")
-
-        results[:body].map { |r| Mercadolibre::Entity::Category.new(r) }
+        get_request("/sites/#{site_id}/categories").body
       end
 
       def get_category(category_id)
-        result = get_request("/categories/#{category_id}")
-
-        Mercadolibre::Entity::Category.new(result[:body])
+        get_request("/categories/#{category_id}").body
       end
     end
   end

data/lib/mercadolibre/core/collections.rb

@@ -0,0 +1,10 @@
+module Mercadolibre
+  module Core
+    module Collections
+      def get_collection(collection_id)
+        filters = { access_token: @access_token }
+        get_request("/collections/#{collection_id}", filters).body
+      end
+    end
+  end
+end

data/lib/mercadolibre/core/items_and_searches.rb

@@ -6,36 +6,19 @@ module Mercadolibre
 
         filters.merge!({ access_token: @access_token, limit: 50, offset: 0 })
 
-        response = get_request("/users/#{user_id}/items/search", filters)[:body]
-
-        {
-          results: response['results'],
-          paging: response['paging']
-        }
+        get_request("/users/#{user_id}/items/search", filters).body
       end
 
       def get_item_ids(filters={})
-        response = get_request("/sites/#{@site}/search", filters)[:body]
-
-        {
-          results: response['results'].map { |r| r['id'] },
-          paging: response['paging']
-        }
+        get_request("/sites/#{@site}/search", filters).body
       end
 
       def search_items(filters={})
-        response = get_request("/sites/#{@site}/search", filters)[:body]
-
-        {
-          results: response['results'].map { |x| Mercadolibre::Entity::Item.new(x) },
-          paging: response['paging']
-        }
+        get_request("/sites/#{@site}/search", filters).body
       end
 
       def get_item(item_id)
-        result = get_request("/items/#{item_id}")
-
-        Mercadolibre::Entity::Item.new(result[:body])
+        get_request("/items/#{item_id}").body
       end
 
       def get_item_visits(item_ids)
@@ -43,48 +26,39 @@ module Mercadolibre
           result = { }
 
           item_ids.each_slice(50) do |ids_group|
-            result.merge!(get_request("/visits/items?ids=#{ids_group.join(',')}")[:body])
+            filters = { ids: ids_group.join(','), api_response_kind: 'hash' }
+            result.merge!(get_request('/visits/items', filters).body)
           end
 
           result
         else
-          get_request("/visits/items?ids=#{item_ids}")[:body][item_ids]
+          filters = { ids: ids_group.join(','), api_response_kind: 'hash' }
+          get_request('/visits/items', filters).body[item_ids]
         end
       end
 
       def get_item_description(item_id)
-        result = get_request("/items/#{item_id}/description")
-
-        Mercadolibre::Entity::ItemDescription.new(result[:body])
+        get_request("/items/#{item_id}/description").body
       end
 
       def get_item_descriptions(item_id)
-        results = get_request("/items/#{item_id}/descriptions")
-
-        results[:body].map { |r| Mercadolibre::Entity::ItemDescription.new(r) }
+        get_request("/items/#{item_id}/descriptions").body
       end
 
       def get_item_available_upgrades(item_id)
-        results = get_request("/items/#{item_id}/available_upgrades?access_token=@access_token")
-
-        results[:body].map { |r| Mercadolibre::Entity::ListingType.new(r) }
+        get_request("/items/#{item_id}/available_upgrades?access_token=@access_token").body
       end
 
       def get_search_url(site_id, q)
-        result = get_request("/sites/#{site_id}/searchUrl?q=#{q}")
-        result[:body]['url']
+        get_request("/sites/#{site_id}/searchUrl?q=#{q}").body.url
       end
 
       def get_hot_items(site_id, category_id, limit=15)
-        results = get_request("/sites/#{site_id}/hot_items/search?category=#{category_id}&limit=#{limit}")
-
-        results[:body].map { |r| Mercadolibre::Entity::Item.new(r) }
+        get_request("/sites/#{site_id}/hot_items/search?category=#{category_id}&limit=#{limit}").body
       end
 
       def get_featured_items(site_id, pool_id)
-        results = get_request("/sites/#{site_id}/featured_items/#{pool_id}")
-
-        results[:body].map { |r| Mercadolibre::Entity::FeaturedItem.new(r) }
+        get_request("/sites/#{site_id}/featured_items/#{pool_id}").body
       end
 
       def get_site_trends(site_id, category_id=nil)
@@ -94,9 +68,7 @@ module Mercadolibre
           params = { }
         end
 
-        results = get_request("/sites/#{site_id}/trends/search", params)
-
-        results[:body].map { |r| Mercadolibre::Entity::SiteTrend.new(r) }
+        get_request("/sites/#{site_id}/trends/search", params).body
       end
 
       def item_valid?(attribs)
@@ -106,7 +78,7 @@ module Mercadolibre
 
         result = post_request("/items/validate?access_token=#{@access_token}", payload, headers)
 
-        (result[:status_code].to_s == '204')
+        (result.status_code.to_s == '204')
       end
 
       def create_item(attribs)
@@ -114,9 +86,7 @@ module Mercadolibre
 
         headers = { content_type: :json }
 
-        result = post_request("/items?access_token=#{@access_token}", payload, headers)
-
-        Mercadolibre::Entity::Item.new(result[:body])
+        post_request("/items?access_token=#{@access_token}", payload, headers).body
       end
 
       def relist_item(item_id, price, quantity, listing_type_id)
@@ -124,9 +94,7 @@ module Mercadolibre
 
         headers = { content_type: :json, accept: :json }
 
-        result = post_request("/items/#{item_id}/relist?access_token=#{@access_token}", payload, headers)
-
-        Mercadolibre::Entity::Item.new(result[:body])
+        post_request("/items/#{item_id}/relist?access_token=#{@access_token}", payload, headers).body
       end
 
       def update_item_fields(item_id, attribs)
@@ -134,7 +102,7 @@ module Mercadolibre
 
         headers = { content_type: :json, accept: :json }
 
-        put_request("/items/#{item_id}?access_token=#{@access_token}", payload, headers)[:body]
+        put_request("/items/#{item_id}?access_token=#{@access_token}", payload, headers).body
       end
 
       def update_item_listing_type(item_id, listing_type_id)
@@ -142,7 +110,7 @@ module Mercadolibre
 
         headers = { content_type: :json, accept: :json }
 
-        post_request("/items/#{item_id}/listing_type?access_token=#{@access_token}", payload, headers)[:body]
+        post_request("/items/#{item_id}/listing_type?access_token=#{@access_token}", payload, headers).body
       end
 
       def add_item_description(item_id, text)
@@ -150,7 +118,7 @@ module Mercadolibre
 
         headers = { content_type: :json, accept: :json }
 
-        post_request("/items/#{item_id}/descriptions?access_token=#{@access_token}", payload, headers)[:body]
+        post_request("/items/#{item_id}/descriptions?access_token=#{@access_token}", payload, headers).body
       end
 
       def update_item_attributes(item_id, attrs)
@@ -158,8 +126,7 @@ module Mercadolibre
 
         headers = { content_type: :json, accept: :json }
 
-        put_request("/items/#{item_id}?access_token=#{@access_token}", payload, headers)[:status_code] == 200
-
+        put_request("/items/#{item_id}?access_token=#{@access_token}", payload, headers).status_code == 200
       end
 
       def delete_item_attributes(item_id, attr_list)
@@ -167,7 +134,7 @@ module Mercadolibre
 
         headers = { content_type: :json, accept: :json }
 
-        put_request("/items/#{item_id}?access_token=#{@access_token}", payload, headers)[:status_code] == 200
+        put_request("/items/#{item_id}?access_token=#{@access_token}", payload, headers).status_code == 200
       end
 
       def update_item_identifiers(item_id, attrs)
@@ -175,13 +142,11 @@ module Mercadolibre
 
         headers = { content_type: :json }
 
-        put_request("/items/#{item_id}/product_identifiers?access_token=#{@access_token}", payload, headers)[:status_code] == 200
+        put_request("/items/#{item_id}/product_identifiers?access_token=#{@access_token}", payload, headers).status_code == 200
       end
 
       def get_item_identifiers(item_id)
-        result = get_request("/items/#{item_id}/product_identifiers")
-
-        Mercadolibre::Entity::ProductIdentifier.new(result[:body])
+        get_request("/items/#{item_id}/product_identifiers").body
       end
     end
   end