sendcloud-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 925c78de85ca4fb2cf19a3c3f3c405bd75317b99
+  data.tar.gz: 6ac99e7ad7e5afbbfd070fedb88df7e67548352b
+SHA512:
+  metadata.gz: f05aa4716beacaaf2918fd93b2aa02d45c1b69d7e3ff2553a766d9cadfcc1e77fec8479928a2d3036c4010a6bd4d9d16b30f3a71201ea22bd91c0d5b9e671541
+  data.tar.gz: 3edc1714714bf6477ff289078e74075a99a084068c47eade006a159f5e89163ae00f8b81c5d16d1bc464222f170353f6af0af84936f3bfe43cd1d68594948413

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014-2015 PeRo ICT Solutions
+
+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,38 @@
+# Sendcloud
+
+***WORK IN PROGRESS***
+
+[![wercker status](https://app.wercker.com/status/03866f33222cc05a0e18eb2aac723f5c/m "wercker status")](https://app.wercker.com/project/bykey/03866f33222cc05a0e18eb2aac723f5c)
+[![Gem Version](https://badge.fury.io/rb/sendcloud.svg)](http://badge.fury.io/rb/sendcloud)
+[![Code Climate](https://codeclimate.com/github/pero-ict-solutions/sendcloud/badges/gpa.svg)](https://codeclimate.com/github/pero-ict-solutions/sendcloud)
+[![Test Coverage](https://codeclimate.com/github/pero-ict-solutions/sendcloud/badges/coverage.svg)](https://codeclimate.com/github/pero-ict-solutions/sendcloud)
+
+Documentation on [RubyDoc](http://www.rubydoc.info/github/pero-ict-solutions/sendcloud/master)
+
+Ruby API Client for the [SendCloud](https://www.sendcloud.nl) delivery platform.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sendcloud-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sendcloud-ruby
+
+## Contributing
+
+1. Fork it ( http://github.com/pero-ict-solutions/sendcloud/fork )
+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
+
+
+Copyright (c) 2014-2015 PeRo ICT Solutions

data/Rakefile

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

data/lib/sendcloud.rb

@@ -0,0 +1,5 @@
+require "sendcloud/version"
+require "sendcloud/base"
+require "sendcloud/shipping_method"
+require "sendcloud/parcel_resource"
+require "sendcloud/shipment_address"

data/lib/sendcloud/base.rb

@@ -0,0 +1,30 @@
+require 'httparty'
+
+module Sendcloud
+  class Base
+    include HTTParty
+    format :json
+    base_uri 'https://panel.sendcloud.nl/api/v2/'
+
+    attr_accessor :api_key, :api_secret
+
+    #
+    # @param api_key [String] the `apikey` from your account settings
+    # @param api_secret [String] the `apisecret` from your account settings
+    def initialize(api_key, api_secret)
+      self.api_key = api_key
+      self.api_secret = api_secret
+    end
+
+    # get the auth hash to use for all the requests
+    # since the sendcloud api uses basic authentication
+    # it will be used in the subclasses like this:
+    # `HTTParty.get("http://twitter.com/statuses/public_timeline.json", :basic_auth => auth)`
+    #
+    # @return [Hash] the basic auth hash based on the api_key and api_secret
+    def auth
+      { username: api_key, password: api_secret}
+    end
+
+  end
+end

data/lib/sendcloud/parcel_resource.rb

@@ -0,0 +1,61 @@
+module Sendcloud
+  class ParcelResourceException < StandardError; end
+
+  class ParcelResource < Base
+    def create_parcel(name, shipment_address, shipment = {id: 1, options: []}, method_params = {})
+      response = self.class.post('/parcels',
+                                 body: {
+                                     parcel: {
+                                         name: name,
+                                         address: shipment_address.address,
+                                         city: shipment_address.city,
+                                         postal_code: shipment_address.postal_code,
+                                         country: shipment_address.country,
+                                         shipment: shipment,
+                                         requestShipment: false
+                                     }.merge(method_params).
+                                       merge(telephone: '', email: '', data: [])
+                                 }.to_json,
+                                  basic_auth: auth,
+                                  headers: {'Content-Type' => 'application/json'}
+      )
+      handle_response_error(response)
+      response['parcel']
+    end
+
+    def adjust_parcel(parcel_id)
+      response = self.class.put('/parcels',
+                                body: {
+                                    parcel: {
+                                        id: parcel_id,
+                                        requestShipment: true
+                                    }
+                                }.to_json,
+                                basic_auth: auth,
+                                headers: {'Content-Type' => 'application/json'}
+      )
+      handle_response_error(response)
+      response['parcel']
+    end
+
+    def show_parcel(parcel_id)
+      response = self.class.get("/parcels/#{parcel_id}", basic_auth: auth)
+      handle_response_error(response)
+      response['parcel']
+    end
+
+    def get_label_parcel(parcel_id)
+      response = self.class.get("/labels/#{parcel_id}", basic_auth: auth,
+                                headers: {'Content-Type' => 'application/json'})
+      handle_response_error(response)
+      response['label']
+    end
+
+    private
+      def handle_response_error(response)
+        if response['error']
+          raise ParcelResourceException.new(response['error']['message'])
+        end
+      end
+  end
+end

data/lib/sendcloud/shipment_address.rb

@@ -0,0 +1,5 @@
+module Sendcloud
+  class ShipmentAddress < Struct.new(:address, :city, :postal_code, :country)
+
+  end
+end

data/lib/sendcloud/shipping_method.rb

@@ -0,0 +1,18 @@
+module Sendcloud
+  class ShippingMethodException < StandardError; end
+
+  class ShippingMethod < Base
+    def list
+      response = self.class.get("/shipping_methods", :basic_auth => auth)
+      response["shipping_methods"]
+    end
+
+    def get(shipping_id)
+      response = self.class.get("/shipping_methods/#{shipping_id}", :basic_auth => auth)
+      if response["error"]
+        raise ShippingMethodException.new(response["error"]["message"])
+      end
+      response["shipping_method"]
+    end
+  end
+end

data/lib/sendcloud/version.rb

@@ -0,0 +1,3 @@
+module Sendcloud
+  VERSION = "1.0.0"
+end

data/sendcloud.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sendcloud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sendcloud-ruby"
+  spec.version       = Sendcloud::VERSION
+  spec.authors       = ["Peter Berkenbosch"]
+  spec.email         = ["peter@pero-ict.nl"]
+  spec.summary       = %q{ruby client for the sendcloud api}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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"]
+
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'yard'
+end

data/spec/lib/sendcloud/base_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Sendcloud::Base do
+
+  context ".auth" do
+    it "returns a hash for basic_auth with api key and secret" do
+      basic_auth_hash = {username: "key", password: "secret"}
+      expect(Sendcloud::Base.new("key","secret").auth).to eql basic_auth_hash
+    end
+  end
+
+end

data/spec/lib/sendcloud/parcel_resource_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe Sendcloud::ParcelResource do
+  let!(:new_parcel){
+    {
+        "name"=>"Rob van den Heuvel",
+        "shipment_address" => Sendcloud::ShipmentAddress.new('Torenallee', 'Eindhoven', '5617BC', 'NL')
+    }
+  }
+  context 'create Parcel' do
+
+    it 'with valid params' do
+      pr = Sendcloud::ParcelResource.new('D74gAPTNto4N28N', 'Yb6m0YVBXtWm2zTdk')
+      VCR.use_cassette('create_parcel') do
+        parcel = pr.create_parcel(new_parcel['name'], new_parcel['shipment_address'], {id: 1})
+        expect(parcel).not_to be_empty
+        expect(parcel).to include('name'=>'Rob van den Heuvel')
+        expect(parcel).to include('id')
+      end
+    end
+
+    context 'without name' do
+      it 'will return a error' do
+        pr = Sendcloud::ParcelResource.new('D74gAPTNto4N28N', 'Yb6m0YVBXtWm2zTdk')
+        VCR.use_cassette('wrong_create_parcel_without_name') do
+          expect{pr.create_parcel(nil, new_parcel['shipment_address'], {id: 1})}.
+              to raise_error(Sendcloud::ParcelResourceException, 'Name is required')
+        end
+      end
+    end
+  end
+
+  context 'adjust Parcel' do
+    it 'with valid parcel_id' do
+      pr = Sendcloud::ParcelResource.new('D74gAPTNto4N28N', 'Yb6m0YVBXtWm2zTdk')
+      VCR.use_cassette('adjust_parcel') do
+        parcel = pr.create_parcel(new_parcel['name'], new_parcel['shipment_address'], {id: 1})
+        adjust_parcel = pr.adjust_parcel(parcel['id'])
+        expect(adjust_parcel).not_to be_empty
+        expect(adjust_parcel['status']).not_to be_empty
+        expect(adjust_parcel).to include('id')
+      end
+    end
+    it 'with invalid parcel_id' do
+      pr = Sendcloud::ParcelResource.new('D74gAPTNto4N28N', 'Yb6m0YVBXtWm2zTdk')
+      VCR.use_cassette('adjust_with_wrong_parcel_id') do
+        parcel_id = 123456
+        expect{pr.adjust_parcel(parcel_id)}.to raise_error(Sendcloud::ParcelResourceException,
+                                                         "Parcel is not found with ID: #{parcel_id}")
+      end
+    end
+  end
+
+  context 'get parcel' do
+    it 'with valid parcel_id' do
+      pr = Sendcloud::ParcelResource.new('D74gAPTNto4N28N', 'Yb6m0YVBXtWm2zTdk')
+      VCR.use_cassette('get_parcel_info') do
+        parcel = pr.create_parcel(new_parcel['name'], new_parcel['shipment_address'], {id: 1})
+        info = pr.show_parcel(parcel['id'])
+        expect(info).not_to be_empty
+        expect(info['id']).to eql(parcel['id'])
+      end
+    end
+
+    it 'with invalid parcel_id' do
+      pr = Sendcloud::ParcelResource.new('D74gAPTNto4N28N', 'Yb6m0YVBXtWm2zTdk')
+      VCR.use_cassette('get_parcel_error_with_invalid_pracel_id') do
+        parcel_id = 123456
+        expect{pr.show_parcel(parcel_id)}.to raise_error(Sendcloud::ParcelResourceException,
+                                                          "You aren't authorized to get this parcel")
+      end
+    end
+  end
+
+  context 'get label' do
+    it 'with valid parcel_id' do
+      pr = Sendcloud::ParcelResource.new('D74gAPTNto4N28N', 'Yb6m0YVBXtWm2zTdk')
+      VCR.use_cassette('get_label_for_parcel') do
+        parcel = pr.create_parcel(new_parcel['name'], new_parcel['shipment_address'], {id: 1})
+        adjust_parcel = pr.adjust_parcel(parcel['id'])
+        label = pr.get_label_parcel(adjust_parcel['id'])
+        expect(label['normal_printer']).not_to be_empty
+        expect(label['label_printer']).not_to be_empty
+      end
+    end
+
+    it 'with invalid parcel_id' do
+      pr = Sendcloud::ParcelResource.new('D74gAPTNto4N28N', 'Yb6m0YVBXtWm2zTdk')
+      VCR.use_cassette('get_label_for_parcel_with_invalid_id') do
+        parcel_id = 123456
+        expect{pr.get_label_parcel(parcel_id)}.to raise_error(Sendcloud::ParcelResourceException,
+                                                              "Cannot find parcel with given Parcel ID (#{parcel_id})")
+      end
+    end
+  end
+end

data/spec/lib/sendcloud/shipping_method_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Sendcloud::ShippingMethod do
+
+  context ".list" do
+    it "returns the list of available shipping methods" do
+      sm = Sendcloud::ShippingMethod.new("key", "secret")
+      VCR.use_cassette('get_shipping_methods') do
+        methods = sm.list
+        expect(methods).to_not be_empty
+      end
+    end
+  end
+
+  context ".get" do
+
+    context "with correct shipping_method id" do
+
+      let(:post_nl_shipping_method_hash) {
+        {
+          "id"=>1,
+          "name"=>"Pakket Nederland (PostNL)",
+          "countries"=>[
+            {
+              "id"=>2,
+              "iso_3"=>"NLD",
+              "iso_2"=>"NL",
+              "name"=>"Nederland",
+              "price"=>5.8
+            }
+          ],
+          "price"=>5.8,
+          "options"=>[],
+          "combinations"=>[{"id"=>1, "name"=>"Normaal pakket"}]
+        }
+      }
+
+      it "will return the shipping method details" do
+        sm = Sendcloud::ShippingMethod.new("D74gAPTNto4N28N", "Yb6m0YVBXtWm2zTdk")
+        VCR.use_cassette('get_shipping_method') do
+          shipping_method = sm.get(1)
+          expect(shipping_method).to eql post_nl_shipping_method_hash
+        end
+      end
+    end
+
+    context "with invalid shipping_method id" do
+      it "will return a proper message" do
+        sm = Sendcloud::ShippingMethod.new("key", "secret")
+        VCR.use_cassette('get_wrong_shipping_method') do
+          expect{sm.get(99)}.to raise_error(Sendcloud::ShippingMethodException, "Can't find shipping method with given ID (99)")
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'sendcloud'
+require 'pry'
+require 'vcr'
+require 'webmock'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :webmock # or :fakeweb
+  c.ignore_hosts 'codeclimate.com'
+end