shipcloud 0.1.0

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/.rspec

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shipcloud.gemspec
+gemspec
+
+gem "rspec"
+gem "rake"
+gem "webmock"
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 sthollmann
+
+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 @@
+# shipcloud
+
+A Ruby wrapper for the shipcloud API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shipcloud'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shipcloud
+
+## Usage
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/shipcloud.rb

@@ -0,0 +1,60 @@
+require "net/http"
+require "net/https"
+require "json"
+require "shipcloud/version"
+
+module Shipcloud
+  API_BASE    = "api.shipcloud.io"
+  API_VERSION = "v1"
+  ROOT_PATH   = File.dirname(__FILE__)
+
+  API_HEADERS = {
+    "Content-Type" => "application/json",
+    "User-Agent" => "shipcloud-ruby v#{Shipcloud::VERSION}, API v#{Shipcloud::API_VERSION}, #{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}"
+  }
+
+  @@api_key = nil
+
+  autoload :Base,           "shipcloud/base"
+  autoload :Shipment,       "shipcloud/shipment"
+
+  module Operations
+    autoload :Create,       "shipcloud/operations/create"
+  end
+
+  module Request
+    autoload :Base,         "shipcloud/request/base"
+    autoload :Connection,   "shipcloud/request/connection"
+    autoload :Info,         "shipcloud/request/info"
+    autoload :Validator,    "shipcloud/request/validator"
+  end
+
+  class ShipcloudError < StandardError; end
+  class AuthenticationError < ShipcloudError; end
+  class APIError            < ShipcloudError; end
+
+  # Returns the set api key
+  #
+  # @return [String] The api key
+  def self.api_key
+    @@api_key
+  end
+
+  # Sets the api key
+  #
+  # @param [String] api_key The api key
+  def self.api_key=(api_key)
+    @@api_key = api_key
+  end
+
+  # Makes a request against the shipcloud API
+  #
+  # @param [Symbol] http_method The http method to use, must be one of :get, :post, :put and :delete
+  # @param [String] api_url The API url to use
+  # @param [Hash] data The data to send, e.g. used when creating new objects.
+  # @return [Array] The parsed JSON response.
+  def self.request(http_method, api_url, data)
+    info = Request::Info.new(http_method, api_url, data)
+    Request::Base.new(info).perform
+  end
+end

data/lib/shipcloud/base.rb

@@ -0,0 +1,21 @@
+module Shipcloud
+  class Base
+    include Shipcloud::Operations::Create
+
+    # Initializes an object using the given attributes
+    #
+    # @param [Hash] attributes The attributes to use for initialization
+    def initialize(attributes = {})
+      set_attributes(attributes)
+    end
+
+    # Sets the attributes
+    #
+    # @param [Hash] attributes The attributes to initialize
+    def set_attributes(attributes)
+      attributes.each_pair do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+  end
+end

data/lib/shipcloud/operations/create.rb

@@ -0,0 +1,19 @@
+module Shipcloud
+  module Operations
+    module Create
+      module ClassMethods
+        # Creates a new object
+        #
+        # @param [Hash] attributes The attributes of the created object
+        def create(attributes)
+          response = Shipcloud.request(:post, "#{self.name.split("::").last.downcase}s", attributes)
+          self.new(response)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/shipcloud/request/base.rb

@@ -0,0 +1,33 @@
+module Shipcloud
+  module Request
+    class Base
+      attr_reader :info
+      attr_accessor :response
+
+      def initialize(info)
+        @info = info
+      end
+
+      def perform
+        raise AuthenticationError if Shipcloud.api_key.nil?
+        connection.setup_https
+        send_request
+        validator.validated_data_for(response)
+      end
+
+      protected
+
+      def send_request
+        self.response = connection.request
+      end
+
+      def connection
+        @connection ||= Connection.new(info)
+      end
+
+      def validator
+        @validator ||= Validator.new(info)
+      end
+    end
+  end
+end

data/lib/shipcloud/request/connection.rb

@@ -0,0 +1,43 @@
+module Shipcloud
+  module Request
+    class Connection
+      attr_reader :https
+
+      def initialize(request_info)
+        @info = request_info
+      end
+
+      def setup_https
+        @https             = Net::HTTP.new(API_BASE, Net::HTTP.https_default_port)
+        @https.use_ssl     = true
+        @https.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        # @https.ca_file     = File.join(ROOT_PATH, "data/shipcloud.crt")
+        # @https.set_debug_output $stdout
+      end
+
+      def request
+        https.start do |connection|
+          https.request(https_request)
+        end
+      end
+
+      protected
+
+      def https_request
+        https_request = case @info.http_method
+                        when :post
+                          Net::HTTP::Post.new(@info.url, API_HEADERS)
+                        when :put
+                          Net::HTTP::Put.new(@info.url, API_HEADERS)
+                        when :delete
+                          Net::HTTP::Delete.new(@info.url, API_HEADERS)
+                        else
+                          Net::HTTP::Get.new(@info.path_with_params(@info.url, @info.data), API_HEADERS)
+                        end
+        https_request.basic_auth(Shipcloud.api_key, "")
+        https_request.body = @info.data.to_json if [:post, :put].include?(@info.http_method)
+        https_request
+      end
+    end
+  end
+end

data/lib/shipcloud/request/info.rb

@@ -0,0 +1,27 @@
+module Shipcloud
+  module Request
+    class Info
+      attr_accessor :http_method, :api_url, :data
+
+      def initialize(http_method, api_url, data)
+        @http_method = http_method
+        @api_url     = api_url
+        @data        = data
+      end
+
+      def url
+        url = "/#{API_VERSION}/#{api_url}"
+        url
+      end
+
+      def path_with_params(path, params)
+        unless params.empty?
+          encoded_params = URI.encode_www_form(params)
+          [path, encoded_params].join("?")
+        else
+          path
+        end
+      end
+    end
+  end
+end

data/lib/shipcloud/request/validator.rb

@@ -0,0 +1,31 @@
+module Shipcloud
+  module Request
+    class Validator
+      attr_reader :info
+      attr_accessor :response
+
+      def initialize(info)
+        @info = info
+      end
+
+      def validated_data_for(incoming_response)
+        self.response = incoming_response
+        verify_response_code
+        info.data = JSON.parse(response.body)
+        validate_response_data
+        info.data
+      end
+
+      protected
+
+      def verify_response_code
+        raise AuthenticationError if response.code.to_i == 401
+        raise APIError if response.code.to_i >= 500
+      end
+
+      def validate_response_data
+        raise APIError.new(info.data["error"]) if info.data["error"]
+      end
+    end
+  end
+end

data/lib/shipcloud/shipment.rb

@@ -0,0 +1,7 @@
+module Shipcloud
+  class Shipment < Base
+
+    attr_accessor :to, :carrier, :package
+    attr_reader :id, :tracking_url, :label_url, :price
+  end
+end

data/lib/shipcloud/version.rb

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

data/shipcloud.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shipcloud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shipcloud"
+  spec.version       = Shipcloud::VERSION
+  spec.authors       = ["sthollmann"]
+  spec.email         = ["stefan@webionate.de"]
+  spec.description   = %q{A wrapper for the shipcloud API}
+  spec.summary       = %q{A wrapper for the shipcloud API}
+  spec.homepage      = "https://github.com/webionate/shipcloud-ruby"
+  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"]
+
+  spec.add_dependency "json"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/shipcloud/request/base_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe Shipcloud::Request::Base do
+  context "#perform" do
+    it "checks for an api key" do
+      Shipcloud.stub(:api_key).and_return(nil)
+
+      expect{
+        Shipcloud::Request::Base.new(nil).perform
+      }.to raise_error Shipcloud::AuthenticationError
+    end
+
+    it "performs an https request" do
+      Shipcloud.stub(:api_key).and_return("some key")
+      connection = stub
+      validator = stub
+      Shipcloud::Request::Connection.stub(:new).and_return(connection)
+      Shipcloud::Request::Validator.stub(:new).and_return(validator)
+
+      connection.should_receive(:setup_https)
+      connection.should_receive(:request)
+      validator.should_receive(:validated_data_for)
+
+      Shipcloud::Request::Base.new(nil).perform
+    end
+  end
+end

data/spec/shipcloud/request/connection_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Shipcloud::Request::Connection do
+  describe "#setup_https" do
+    it "creates a https object" do
+      connection = Shipcloud::Request::Connection.new(nil)
+
+      connection.setup_https
+
+      connection.https.should_not be_nil
+    end
+  end
+
+  describe "#request" do
+    it "performs the actual request" do
+      connection = Shipcloud::Request::Connection.new(nil)
+      connection.setup_https
+      connection.stub(:https_request)
+
+      connection.https.should_receive(:request)
+
+      connection.request
+    end
+  end
+end

data/spec/shipcloud/request/validator_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Shipcloud::Request::Validator do
+  describe "#validated_data_for" do
+    it "validates the data" do
+      info = Shipcloud::Request::Info.new(:get, "random", OpenStruct.new(id: 1))
+      validator = Shipcloud::Request::Validator.new info
+      response = OpenStruct.new(body: '{"response":"ok"}', code: 200)
+
+      validator.validated_data_for(response).should eq "response" => "ok"
+    end
+  end
+end

data/spec/shipcloud/shipment_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Shipcloud::Shipment do
+  let(:valid_attributes) do
+    {
+      to: {
+        company: 'shipcloud GmbH',
+        first_name:   'Max',
+        last_name: 'Mustermann',
+        street: 'Musterallee',
+        street_no: '43',
+        city: 'Berlin',
+        zip_code: '10000',
+      },
+      carrier: 'dhl',
+      package: {
+        weight: 2.5,
+        length: 40,
+        width: 20,
+        height: 20
+      }
+    }
+  end
+
+  let(:shipment) {
+    Shipcloud::Shipment.new(valid_attributes)
+  }
+
+  describe "#initialize" do
+    it "initializes all attributes correctly" do
+      expect(shipment.to[:company]).to eq 'shipcloud GmbH'
+      expect(shipment.to[:first_name]).to eq 'Max'
+      expect(shipment.to[:last_name]).to eq 'Mustermann'
+      expect(shipment.to[:street]).to eq 'Musterallee'
+      expect(shipment.to[:street_no]).to eq '43'
+      expect(shipment.to[:city]).to eq 'Berlin'
+      expect(shipment.to[:zip_code]).to eq '10000'
+
+      expect(shipment.carrier).to eq 'dhl'
+
+      expect(shipment.package[:weight]).to eq 2.5
+      expect(shipment.package[:length]).to eq 40
+      expect(shipment.package[:width]).to eq 20
+      expect(shipment.package[:height]).to eq 20
+    end
+  end
+
+  describe ".create" do
+    it "makes a new POST request using the correct API endpoint" do
+      Shipcloud.should_receive(:request).with(:post, "shipments", valid_attributes).and_return("data" => {})
+      Shipcloud::Shipment.create(valid_attributes)
+    end
+  end
+end

data/spec/shipcloud_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe Shipcloud do
+  describe ".request" do
+    context "given no api key exists" do
+      it "raises an authentication error" do
+        expect { Shipcloud.request(:get, "clients", {}) }.to raise_error(Shipcloud::AuthenticationError)
+      end
+    end
+
+    context "with an invalid api key" do
+      before(:each) do
+        WebMock.stub_request(:any, /#{Shipcloud::API_BASE}/).to_return(:body => "{}")
+        Shipcloud.api_key = "your-api-key"
+      end
+
+      it "attempts to get a url with one param" do
+        Shipcloud.request(:get, "transactions", { param_name: "param_value" })
+        WebMock.should have_requested(:get, "https://#{Shipcloud::api_key}:@#{Shipcloud::API_BASE}/#{Shipcloud::API_VERSION}/transactions?param_name=param_value")
+      end
+
+      it "attempts to get a url with more than one param" do
+        Shipcloud.request(:get, "transactions", { client: "client_id", order: "created_at_desc" })
+        WebMock.should have_requested(:get, "https://#{Shipcloud::api_key}:@#{Shipcloud::API_BASE}/#{Shipcloud::API_VERSION}/transactions?client=client_id&order=created_at_desc")
+      end
+
+      it "doesn't add a question mark if no params" do
+        Shipcloud.request(:get, "transactions", {})
+        WebMock.should have_requested(:get, "https://#{Shipcloud::api_key}:@#{Shipcloud::API_BASE}/#{Shipcloud::API_VERSION}/transactions")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'shipcloud'
+require 'rspec'
+require "webmock/rspec"
+require "pry"

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: shipcloud
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- sthollmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A wrapper for the shipcloud API
+email:
+- stefan@webionate.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shipcloud.rb
+- lib/shipcloud/base.rb
+- lib/shipcloud/operations/create.rb
+- lib/shipcloud/request/base.rb
+- lib/shipcloud/request/connection.rb
+- lib/shipcloud/request/info.rb
+- lib/shipcloud/request/validator.rb
+- lib/shipcloud/shipment.rb
+- lib/shipcloud/version.rb
+- shipcloud.gemspec
+- spec/shipcloud/request/base_spec.rb
+- spec/shipcloud/request/connection_spec.rb
+- spec/shipcloud/request/validator_spec.rb
+- spec/shipcloud/shipment_spec.rb
+- spec/shipcloud_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/webionate/shipcloud-ruby
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A wrapper for the shipcloud API
+test_files:
+- spec/shipcloud/request/base_spec.rb
+- spec/shipcloud/request/connection_spec.rb
+- spec/shipcloud/request/validator_spec.rb
+- spec/shipcloud/shipment_spec.rb
+- spec/shipcloud_spec.rb
+- spec/spec_helper.rb
+has_rdoc: