packlink_lite 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcd5d4af3dbd874f0f5de6ba024e4e6ca3ba3770
-  data.tar.gz: 7cba79eae714f11570a8c60716635e4a0d8da2c5
+  metadata.gz: 7ccaab6fdc49a94edc939dd75fb129a75d188a6e
+  data.tar.gz: effae85c177be32d29907f89948d1859a06b3f36
 SHA512:
-  metadata.gz: 116974f970164cc7e9bd429822b28f89d8263375d3d4f5f09d0e600ca9de3a1d3276148700dd58e4020e37206ad57fb663550b31655fe750090dae0a77bc15c7
-  data.tar.gz: 7c99040a265acf725f20901de705c9e979995ed2b4010e4c0db971e874dad15b49a80802dc98f4bfbe4ec50ecd105f85a2a7a49a25ca6419c34a07230f0eaf6d
+  metadata.gz: 262a7e460c8fb55bd3e23273e5978525e780d83d0544910ff7e4e277288f09f5f39d966717f9d8f5bf3306ad062cead28bec0ab60df7a076b4326a7c506f5cbb
+  data.tar.gz: 108d0de88dfaf74dbeff54098c595218f8b67d6ab0ee3d7a186a9e0f7dd400030604d80d02e58c05e2392b5e84cdfebafdaca77df14e441663517434ad3a96ba

data/README.md

@@ -21,6 +21,14 @@ PacklinkLite.configure do |config|
 end
 ```
 
+API key can be passed via options too:
+
+```ruby
+PacklinkLite::Service.all(query, api_key: 'mykey')
+PacklinkLite::Order.create(order_hash, api_key: 'mykey')
+
+```
+
 ## Usage
 
 ### Fetch services list

data/lib/packlink_lite/client.rb

@@ -1,80 +1,69 @@
-require 'rest-client'
+require 'faraday'
+require 'faraday_middleware'
 
 module PacklinkLite
   class Client
     def get(path, params = nil, options = {})
-      url = url(path)
-      url+= '?' + build_nested_query(params) if params
-      response = request(:get, url, headers)
-      process_response(response, options)
+      with_error_handling do
+        response = connection(options[:api_key]).get(path, params)
+        response.body
+      end
     end
 
     def post(path, payload, options = {})
-      payload = payload.to_json unless payload.is_a?(String)
-      response = request(:post, url(path), payload, headers)
-      process_response(response, options)
+      with_error_handling do
+        response = connection(options[:api_key]).post(path, payload)
+        response.body
+      end
     end
 
     def delete(path, options = {})
-      response = request(:delete, url(path))
-      process_response(response, options)
+      with_error_handling do
+        response = connection(options[:api_key]).delete(path)
+        response.body
+      end
     end
 
     private
 
-    def process_response(response, parse_response: true)
-      return response unless parse_response
-      parse_response(response)
+    def with_error_handling
+      yield
+    rescue Faraday::ClientError => e
+      message = extract_error_message(e.response[:body]) || e.message
+      raise(Error, message)
     end
 
-    def request(method, *args)
-      RestClient.send(method, *args)
-    rescue RestClient::Exception => e
-      message = extract_error_message(e.http_body) || e.message
-      raise Error.new(message, e.http_body, e.http_code)
+    def connection(api_key)
+      @connection ||= build_connection
+      @connection.headers['Authorization'] = api_key || PacklinkLite.config.api_key
+      @connection
     end
 
-    def extract_error_message(body)
-      result = parse_response(body)
-      result['message'] || result['messages']
-    rescue JSON::ParserError
-    end
+    def build_connection
+      Faraday.new(url: PacklinkLite.url) do |builder|
+        builder.options[:timeout] = config.timeout
+        builder.options[:open_timeout] = config.timeout
 
-    def url(path)
-      PacklinkLite.url + path
-    end
+        builder.request :retry
+        builder.request :json
 
-    def parse_response(response)
-      JSON.parse(response)
-    rescue JSON::ParserError => e
-      raise ResponseError.new(e.message, response)
-    end
+        builder.headers['Accept'] = 'application/json'
 
-    def headers
-      { 'Authorization' => PacklinkLite.config.api_key,
-        'Content-Type' => 'application/json' }
-    end
+        builder.response :json, content_type: /\bjson$/
+        builder.response :raise_error
 
-    def build_nested_query(value, prefix = nil)
-      case value
-      when Array
-        value.map { |v|
-          build_nested_query(v, "#{prefix}[]")
-        }.join("&")
-      when Hash
-        value.map { |k, v|
-          build_nested_query(v, prefix ? "#{prefix}[#{escape(k)}]" : escape(k))
-        }.reject(&:empty?).join('&')
-      when nil
-        prefix
-      else
-        raise ArgumentError, "value must be a Hash" if prefix.nil?
-        "#{prefix}=#{escape(value)}"
+        builder.adapter Faraday.default_adapter
       end
     end
 
-    def escape(s)
-      URI.encode_www_form_component(s)
+    def extract_error_message(response_body)
+      result = JSON.parse(response_body)
+      result['message'] || result['messages']
+    rescue JSON::ParserError
+    end
+
+    def config
+      PacklinkLite.config
     end
   end
 end

data/lib/packlink_lite/configuration.rb

@@ -1,6 +1,10 @@
 module PacklinkLite
   class Configuration
-    attr_accessor :api_key, :testing
+    attr_accessor :api_key, :testing, :timeout
     alias_method :testing?, :testing
+
+    def timeout
+      @timeout || 60
+    end
   end
 end

data/lib/packlink_lite/label.rb

@@ -1,7 +1,7 @@
 module PacklinkLite
   class Label
-    def self.all(shipment_reference)
-      PacklinkLite.client.get("shipments/#{shipment_reference}/labels")
+    def self.all(shipment_reference, options = {})
+      PacklinkLite.client.get("shipments/#{shipment_reference}/labels", {}, options)
     end
   end
 end

data/lib/packlink_lite/order.rb

@@ -2,8 +2,8 @@ module PacklinkLite
   class Order
     PATH = 'orders'
 
-    def self.create(payload)
-      PacklinkLite.client.post(PATH, payload)
+    def self.create(payload, options = {})
+      PacklinkLite.client.post(PATH, payload, options)
     end
   end
 end

data/lib/packlink_lite/service.rb

@@ -2,8 +2,8 @@ module PacklinkLite
   class Service
     PATH = 'services'
 
-    def self.all(query)
-      PacklinkLite.client.get(PATH, query)
+    def self.all(query, options = {})
+      PacklinkLite.client.get(PATH, query, options)
     end
   end
 end

data/lib/packlink_lite/shipment.rb

@@ -2,12 +2,12 @@ module PacklinkLite
   class Shipment
     PATH = 'shipments'
 
-    def self.all(params = {})
-      PacklinkLite.client.get(PATH, params)
+    def self.all(params = {}, options = {})
+      PacklinkLite.client.get(PATH, params, options)
     end
 
-    def self.find(reference)
-      PacklinkLite.client.get(PATH + '/' + reference)
+    def self.find(reference, options = {})
+      PacklinkLite.client.get(PATH + '/' + reference, {}, options)
     end
   end
 end

data/lib/packlink_lite/tracking_history.rb

@@ -1,7 +1,7 @@
 module PacklinkLite
   class TrackingHistory
-    def self.find(shipment_reference)
-      PacklinkLite.client.get("shipments/#{shipment_reference}/track")
+    def self.find(shipment_reference, options = {})
+      PacklinkLite.client.get("shipments/#{shipment_reference}/track", {}, options)
     end
   end
 end

data/lib/packlink_lite/version.rb

@@ -1,3 +1,3 @@
 module PacklinkLite
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/packlink_lite.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rest-client', '~> 1.8'
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.10'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: packlink_lite
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Laurynas Butkus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -141,9 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Packlink.com API client
 test_files: []
-has_rdoc: