blomming_api 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c2456b1f3eb51b26cc2aae945cef36703ca9db8
+  data.tar.gz: e1e42675078f500ce983a3693b8d956101fa208d
+SHA512:
+  metadata.gz: 33ead1f763c3de18beae8866d348f52afe2651c7fc70817e87c97df7445459a42551c185ad02c0227e76457e0b06e79ea6fff0e45cd62cfcd12d0566a7788764
+  data.tar.gz: 8b5f3d687c512039f06cb3b462097ad24f5c2af0670dbae0cdb305434b5185b23866761eb93cd50e167b7dfdf1dbfd0863f55a870ebebdf1ead0fbff2463bce1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blomming_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Giorgio Robino
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# BlommingApi
+
+www.blomming.com social commerce API's wrapper: supply a client access layer that embed authentication and communication details, supply API endpoints wrappers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blomming_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blomming_api
+
+## Usage
+
+https://github.com/solyaris/blomming_api
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/blomming_api

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+require 'blomming_api'
+
+USAGE = <<ENDUSAGE
+
+Usage: blomming_api [option]
+\t-a: Authentication set-up help 
+\t-e: Endpoints methods list 
+\t-v: Version and gem info
+
+ENDUSAGE
+
+if ARGV.empty?
+  puts USAGE
+  exit
+end
+
+option = ARGV[0].downcase
+
+if option == "-v"
+  puts
+  puts "About gem:"
+  puts BlommingApi::about
+  puts
+elsif option == "-a"
+  puts
+  puts "Authentication set-up help:"
+  puts BlommingApi::authentication_help
+  puts
+elsif option == "-e"
+  puts
+  puts "Endpoints methods list:\n"
+  BlommingApi::endpoints_help
+  puts
+else
+  puts USAGE  	
+end
+
+

data/blomming_api.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blomming_api/version'
+require 'blomming_api/help'
+require 'blomming_api/config'
+require 'blomming_api/private_helpers'
+require 'blomming_api/oauth_endpoint'
+require 'blomming_api/buy_endpoints'
+require 'blomming_api/sell_endpoints'
+require 'blomming_api/public_helpers'
+
+
+Gem::Specification.new do |spec|
+  spec.name          = "blomming_api"
+  spec.version       = BlommingApi::VERSION
+  spec.authors       = BlommingApi::AUTHORS
+  spec.email         = BlommingApi::EMAILS
+  spec.summary       = BlommingApi::SUMMARY
+  spec.description   = BlommingApi::DESCRIPTION
+  spec.homepage      = BlommingApi::HOMEPAGE
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # because of local variable scope in blocks
+  spec.required_ruby_version = '>= 1.9.0'
+  
+  # runtime dependencies, from others gem
+  spec.add_runtime_dependency "method_source"
+  spec.add_runtime_dependency "rest-client" 
+  spec.add_runtime_dependency "multi_json"
+  spec.add_runtime_dependency "oj"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/blomming_api/buy_endpoints.rb

@@ -0,0 +1,355 @@
+# encoding: utf-8
+require 'multi_json'
+require 'rest_client'
+
+module BlommingApi
+  module BuyEndpoints
+    #
+    # CARTS
+    #
+    def carts_add(skus, params={})
+      url = api_url '/carts/add'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      load = MultiJson.dump skus
+
+      load_or_retry do
+        # POST with raw JSON payloads ?
+        RestClient.put url, load, req
+      end  
+    end
+
+    def carts_checkout(order, params={})
+      url = api_url '/carts/checkout'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      load = MultiJson.dump order
+      
+      load_or_retry do
+        # POST with raw JSON payloads ?
+        RestClient.post url, load, req
+      end  
+    end
+
+    def carts_clear(params={})
+      url = api_url '/carts/clear'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+
+      load_or_retry do
+        # PUT with a hash sends parameters as a urlencoded form body ?
+        RestClient.put url, req
+      end  
+    end
+
+    def carts_create(sku_id, params={})
+      url = api_url '/carts/create'
+      req = request_params({sku_id: sku_id, currency: @currency}.merge(params))
+ 
+      # debug
+      puts req
+      
+      load_or_retry do
+        # with a hash sends parameters as a urlencoded form body
+        RestClient.post url, req #load,
+      end  
+    end
+=begin
+    def carts_create(sku_id, params={})
+      url = api_url '/carts/create'
+      req = request_params(params)
+ 
+      load = MultiJson.dump({sku_id: sku_id, currency: @currency})
+      
+      # debug
+      puts load
+      
+      load_or_retry do
+        RestClient.post url, load, req
+      end  
+    end
+=end
+
+
+    def carts_place_paypal_order(paypal_order, params={})
+      url = api_url '/carts/place_paypal_order'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      load = MultiJson.dump paypal_order
+      
+      load_or_retry do
+        RestClient.post url, load, req
+      end  
+    end
+
+    def carts_remove(skus, params={})
+      url = api_url '/carts/remove'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      load = MultiJson.dump skus
+
+      load_or_retry do
+        RestClient.put url, load, req
+      end  
+    end
+
+    def carts_shipping_countries(params={})
+      url = api_url '/carts/shipping_countries'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+
+      load_or_retry do
+        RestClient.get url, req
+      end  
+    end
+
+    def carts_show(cart_id, params={})
+      url = api_url '/carts/#{cart_id}/show'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+
+      load_or_retry do
+        RestClient.get url, req
+      end  
+    end
+
+    def carts_validate(cart_id, params={})
+      url = api_url '/carts/#{cart_id}/validate'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+
+      load_or_retry do
+        RestClient.get url, req
+      end  
+    end
+
+
+    #
+    # CATEGORIES
+    #
+    def categories(params={})
+      url = api_url '/categories'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req
+      end  
+    end
+
+    def category_items (category_id, params={})
+      url = api_url "/categories/#{category_id}/items" 
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req
+      end    
+    end
+
+    #
+    # COLLECTIONS
+    #
+    def collections(params={})
+      url = api_url '/collections'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req 
+      end  
+    end
+
+    def collection_items (collection_id, params={})
+      url = api_url "/collections/#{collection_id}/items"
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req
+      end  
+    end
+
+    #
+    # COUNTRIES
+    #
+    def countries(params={})
+      url = api_url '/countries'
+      req = request_params({locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req
+      end  
+    end
+
+    #
+    # CURRENCIES
+    #
+    def currencies(params={})
+      url = api_url '/currencies'
+      req = request_params({locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req
+      end  
+    end
+    
+    #
+    # ITEMS
+    #
+    def items_discounted(params={})
+      url = api_url '/items/discounted'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      
+      load_or_retry do 
+        RestClient.get url, req
+      end  
+    end
+
+    def items_featured(params={})
+      url = api_url '/items/featured'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      
+      load_or_retry do 
+        RestClient.get url, req
+      end     
+    end
+
+    def items_hand_picked(params={})
+      url = api_url '/items/hand_picked'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req
+      end   
+    end
+
+    def items_list (item_id, params={})
+      url = api_url '/items/list'
+      req = request_params({id: item_id, currency: @currency, locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req
+      end  
+    end
+
+    def items_most_liked(params={})
+      url = api_url '/items/most_liked'
+      req = request_params({currency: @currency, locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req
+      end  
+    end
+
+    def items_search (keyword, params={})
+      url = api_url '/items/search'
+      req = request_params({q: keyword, currency: @currency, locale: @locale}.merge(params))
+      
+      load_or_retry do 
+        RestClient.get url, req
+      end  
+    end
+
+    #
+    # MACROCATEGORIES
+    #
+    def macrocategories(params={})
+      url = api_url '/macrocategories'
+      req = request_params({locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req
+      end  
+    end
+
+    def macrocategory_categories (macrocategory_id​, params={})
+      url = api_url "/macrocategories​/:macrocategory_id​/categories" 
+      req = request_params({locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req
+      end    
+    end
+
+    def macrocategory_items (macrocategory_id​, params={})
+      url = api_url "/macrocategories​/:macrocategory_id​/items" 
+      req = request_params({locale: @locale}.merge(params))
+      
+      load_or_retry do
+        RestClient.get url, req
+      end    
+    end
+
+
+    #
+    # PASSWORD_RESETS
+    #
+    def password_resets (email_of_user, params={})
+      url = api_url "/password_resets"    
+      
+      load_or_retry do
+        # payload JSON ?
+        RestClient.post url, {email_of_user: email_of_user}.merge(params)
+      end  
+    end
+
+
+    #
+    # PROVINCES
+    #
+    def provinces (province_country_code, params={})
+      url = api_url "/provinces/#{province_country_code}"    
+      
+      load_or_retry do 
+        RestClient.get url, request_params(params)
+      end  
+    end
+
+    #
+    # SHOPS
+    #
+    def shops (params={})
+      url = api_url '/shops'
+      
+      load_or_retry do
+        RestClient.get url, request_params(params)
+      end  
+    end
+
+    def shop_items (shop_id, params={})
+      url = api_url "/shops/#{shop_id}/items"
+      
+      data = load_or_retry  do
+        RestClient.get url, request_params(params)
+      end
+
+      #puts_response_header(__method__, data) if @verbose  
+      data
+    end
+
+    def shop_item (shop_id, item_id, params={})
+      url = api_url "/shops/#{shop_id}/items/#{item_id}"
+      
+      load_or_retry do
+        RestClient.get url, request_params(params)
+      end  
+    end
+
+    def shops_find (shop_id, params={})
+      url = api_url "/shops/#{shop_id}"
+      
+      load_or_retry do
+        RestClient.get url, request_params(params)
+      end  
+    end
+
+    #
+    # TAGS
+    #
+    def tags (params={})
+      url = api_url "/tags"
+      
+      load_or_retry do 
+        RestClient.get url, request_params(params)
+      end  
+    end
+
+    def tags_items (tag_id, params={})
+      url = api_url "/tags/#{tag_id}/items"
+      
+      load_or_retry do
+        RestClient.get url, request_params(params)
+      end  
+    end
+
+  end
+end

data/lib/blomming_api/config.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+require 'yaml'
+
+module BlommingApi
+  module Config
+
+    def read_config_file(config_filename)
+
+      # initialize instance variables, from config file 
+      config = YAML.load_file config_filename
+
+      #
+      # initialize instance variables, from config files
+      # validating mandatory fields
+
+      @description  = config['description']
+      
+      # services: buy or sell
+      @services  = config['services']
+      if (@services.downcase =~ /buy|sell/).nil?
+        raise "FATAL: config value for: services (#@services): invalid" 
+      end
+
+      @username  = config['username']
+      if !(@services.downcase =~ /sell/).nil? && @username.nil?
+        raise "FATAL: config value for: username: must be specified"
+      end
+
+      @password  = config['password']
+      if !(@services.downcase =~ /sell/).nil? && @password.nil?
+        raise "FATAL: config value for: password: must be specified"
+      end
+
+      @client_id  = config['client_id']
+      raise "FATAL: config value for: client_id: must be specified" if @client_id.nil?
+
+      @client_secret  = config['client_secret']
+      raise "FATAL: value for: client_secret: must be specified" if @client_secret.nil?
+
+      @domain  = config['domain']
+      if (@domain.downcase =~ /https:\/\/|blomming/).nil?
+        raise "FATAL: config value for: domain (#@services) invalid"
+      end
+
+      @api_version  = config['api_version']
+      if (@api_version =~ /\/v\d+/).nil?
+        raise "FATAL: config value for: api_version (#@api_version): invalid"
+      end
+
+      # default API endpoint parameters values 
+      @currency = config['default_currency']
+      @locale = config['default_locale']
+
+      # other behaviours
+      @verbose = config['verbose']
+      @verbose_access_token = @verbose
+      puts to_s(config_filename) if @verbose
+    end
+    private :read_config_file
+
+    def show_config_file (config_file)
+      "config file: #{config_file}\n\n" + 
+      "\tdescription: #@description\n" +   
+      "\tservices: #@services\n" + 
+      "\tusername: #@username\n"  +
+      "\tpassword: #@password\n" + 
+      "\tclient_id: #@client_id\n" + 
+      "\tclient_secret: #@client_secret\n" + 
+      "\tdomain: #@domain\n" +
+      "\tdefault_currency: #@currency\n" + 
+      "\tdefault_locale: #@locale\n\n" 
+    end
+    public :show_config_file
+
+  end
+end