packlink_lite 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ff464661f493b1f01020f2db2bf298cdeae58e8
+  data.tar.gz: 0091ddb428e56da4c4c1c603c56bd5c399e6981e
+SHA512:
+  metadata.gz: c667effad5cb1441e491b7fb4f857f8f6e4af04d4937e5d19ea612cc0090731a2419591d66e11fdbba2d9802b185bce4bb2cc12bb06e4d107fb748475f0fb2f3
+  data.tar.gz: 090f5b0896429dbf3c2fd60e09ec3c3fa468e995e4a891235c86f484d8a05f74bb27747c9b173047a2f3f335905acc9e01649148bf31ac7244601fcd0d9ed34f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/.ruby-version
+/.env
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.3
+  - 2.2.3
+  - 2.3.0
+  - jruby-19mode
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Laurynas Butkus
+
+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,56 @@
+# PacklinkLite
+
+[![Build Status](https://travis-ci.org/laurynas/packlink_lite.svg?branch=master)](https://travis-ci.org/laurynas/packlink_lite)
+
+Packlink.com API client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'packlink_lite'
+```
+
+## Configuration
+
+```ruby
+PacklinkLite.configure do |config|
+  config.api_key = ENV['PACKLINK_API_KEY']
+  config.testing = true
+end
+```
+
+## Usage
+
+### Fetch services list
+
+```ruby
+services = PacklinkLite::Service.all(
+  from: { country: 'DE', zip: 56457 },
+  to: { country: 'DE', zip: 56457 },
+  packages: { 0 => { width: 10, height: 10, length: 10, weight: 1 } }
+)
+```
+
+### Create order
+
+```ruby
+order = PacklinkLite::Order.create(order_hash)
+```
+
+### Fetch shipment tracking
+
+```ruby
+tracking_history = PacklinkLite::TrackingHistory.find(shipment_reference)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/laurynas/packlink_lite.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "packlink_lite"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/packlink_lite.rb

@@ -0,0 +1,31 @@
+require 'packlink_lite/version'
+require 'packlink_lite/configuration'
+require 'packlink_lite/client'
+require 'packlink_lite/service'
+require 'packlink_lite/order'
+require 'packlink_lite/shipment'
+require 'packlink_lite/label'
+require 'packlink_lite/tracking_history'
+
+module PacklinkLite
+  PRODUCTION_URL = 'https://api.packlink.com/v1/'
+  SANDBOX_URL = 'https://apisandbox.packlink.com/v1/'
+
+  module_function
+
+  def configure
+    yield(config)
+  end
+
+  def config
+    @configuration ||= Configuration.new
+  end
+
+  def client
+    @client ||= Client.new
+  end
+
+  def url
+    config.testing? ? SANDBOX_URL : PRODUCTION_URL
+  end
+end

data/lib/packlink_lite/client.rb

@@ -0,0 +1,60 @@
+require 'rest-client'
+
+module PacklinkLite
+  class Client
+    def get(path, params = nil)
+      url = url(path)
+      url+= '?' + build_nested_query(params) if params
+      response = RestClient.get(url, headers)
+      handle_response(response)
+    end
+
+    def post(path, payload)
+      payload = payload.to_json unless payload.is_a?(String)
+      response = RestClient.post(url(path), payload, headers)
+      handle_response(response)
+    end
+
+    def delete(path)
+      response = RestClient.delete(url(path))
+      handle_response(response)
+    end
+
+    private
+
+    def url(path)
+      PacklinkLite.url + path
+    end
+
+    def handle_response(response)
+      JSON.parse(response)
+    end
+
+    def headers
+      { 'Authorization' => PacklinkLite.config.api_key,
+        'Content-Type' => 'application/json' }
+    end
+
+    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)}"
+      end
+    end
+
+    def escape(s)
+      URI.encode_www_form_component(s)
+    end
+  end
+end

data/lib/packlink_lite/configuration.rb

@@ -0,0 +1,6 @@
+module PacklinkLite
+  class Configuration
+    attr_accessor :api_key, :testing
+    alias_method :testing?, :testing
+  end
+end

data/lib/packlink_lite/label.rb

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

data/lib/packlink_lite/order.rb

@@ -0,0 +1,9 @@
+module PacklinkLite
+  class Order
+    PATH = 'orders'
+
+    def self.create(payload)
+      PacklinkLite.client.post(PATH, payload)
+    end
+  end
+end

data/lib/packlink_lite/service.rb

@@ -0,0 +1,9 @@
+module PacklinkLite
+  class Service
+    PATH = 'services'
+
+    def self.all(query)
+      PacklinkLite.client.get(PATH, query)
+    end
+  end
+end

data/lib/packlink_lite/shipment.rb

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

data/lib/packlink_lite/tracking_history.rb

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

data/lib/packlink_lite/version.rb

@@ -0,0 +1,3 @@
+module PacklinkLite
+  VERSION = "0.1.0"
+end

data/packlink_lite.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'packlink_lite/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'packlink_lite'
+  spec.version       = PacklinkLite::VERSION
+  spec.authors       = ['Laurynas Butkus']
+  spec.email         = ['laurynas.butkus@gmail.com']
+
+  spec.summary       = %q{Packlink.com API client}
+  spec.description   = %q{Client to access packlink.com shipping API}
+  spec.homepage      = 'https://github.com/laurynas/packlink_lite'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rest-client', '~> 1.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'dotenv', '~> 2.1'
+  spec.add_development_dependency 'webmock', '~> 1.24'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: packlink_lite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Laurynas Butkus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+description: Client to access packlink.com shipping API
+email:
+- laurynas.butkus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/packlink_lite.rb
+- lib/packlink_lite/client.rb
+- lib/packlink_lite/configuration.rb
+- lib/packlink_lite/label.rb
+- lib/packlink_lite/order.rb
+- lib/packlink_lite/service.rb
+- lib/packlink_lite/shipment.rb
+- lib/packlink_lite/tracking_history.rb
+- lib/packlink_lite/version.rb
+- packlink_lite.gemspec
+homepage: https://github.com/laurynas/packlink_lite
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Packlink.com API client
+test_files: []
+has_rdoc: