shipcloud 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjQxNjJjMmI2ODIwMzQ5MjE3NGZmMzE0MDlhNGRlZmIyYWM0OTU2ZA==
+  data.tar.gz: !binary |-
+    ZTk2OTc3ZDM0MmZhYTFiM2U4MTY5NjZjMGVmYzJiZjgzMWNiYjJmYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MWU3YzRmZDBmZWQyOTI5ZDJhMDYyMjU2ZTI2NDI0YjI0YTU0OGZjMDczZmIy
+    OTJhZWEyNzMwNDhlYTJjNTgzOTc4NzFkNTlmYmViODU4OTgzZjMzZDkzZmZk
+    N2EzMzdmMjI3ZWUwY2Y3M2Q0M2VjZDhhNGE1Y2NhMTFkZDYwNzc=
+  data.tar.gz: !binary |-
+    ZjljMjBjMWIzMjU2ZjgyMTAyZGYzZjg4OTA2ZWJmMGY5ZGVjNzE0OTcyNDBh
+    OTRkYzA3NTZkNmJjNTIxODU4MmNlMzZjODVlMjYzNDFhYzAyOGI4ZTFjMmU0
+    NThlYzdiMWIzOGY2YjY0NTRmZGFhZmM4ODEwMTg4ZjUzNTFjMGY=

data/README.md

@@ -19,6 +19,42 @@ Or install it yourself as:
 
 ## Usage
 
+Before using the shipcloud API, you need to set the API access key:
+
+```
+Shipcloud.api_key = 'your-api-key-goes-here'
+```
+
+Since Version 0.3.0, you can also do this via a configuration block, e.g. in an initializer:
+
+```
+Shipcloud.configure do |config|
+  config.api_key = 'your-api-key-goes-here'
+end
+```
+
+You can sign up for a developer account at *[shipcloud.io](http://www.shipcloud.io)*
+
+### Create a new shipment
+
+To create a new Shipment on the shipclod platform, you need to provide the name of the carrier, to- and from-address, and the package dimensions.
+For details, see *[shipcloud API documentation on Shipments](http://docs.shipcloud.apiary.io/#shipmentresources)*
+```
+Shipcloud::Shipment.create(
+    carrier: 'ups', 
+    from: from-address-params, 
+    to: to-address-params,
+    package: package-params,
+    create_shipping_label: true
+)
+```
+
+`Shipment#create` will return shipping label and tracking information, encapsulated in a `Shipcloud::Shipment` object:
+
+```
+shipment = Shipcloud::Shipment.create(...) # parameters ommitted
+shipment.tracking_url # -> http://track.shipcloud.io/uzdgu22z3ed12
+```
 
 ## Contributing
 

data/lib/shipcloud.rb

@@ -4,13 +4,12 @@ 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}"
+    "User-Agent" => "shipcloud-ruby v#{Shipcloud::VERSION}, API #{Shipcloud::API_VERSION}, #{RUBY_VERSION}, #{RUBY_PLATFORM}, #{RUBY_PATCHLEVEL}"
   }
 
   @@api_key = nil
@@ -21,6 +20,8 @@ module Shipcloud
   module Operations
     autoload :Create,       "shipcloud/operations/create"
     autoload :Find,         "shipcloud/operations/find"
+    autoload :Delete,       "shipcloud/operations/delete"
+    autoload :Update,       "shipcloud/operations/update"
   end
 
   module Request
@@ -34,11 +35,34 @@ module Shipcloud
   class AuthenticationError < ShipcloudError; end
   class APIError            < ShipcloudError; end
 
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+
+  class Configuration
+    attr_accessor :api_key, :api_base, :use_ssl
+
+    def initialize
+      @api_key = nil
+      @api_base = 'api.shipcloud.io'
+      @use_ssl = true
+    end
+  end
+
   # Returns the set api key
   #
   # @return [String] The api key
   def self.api_key
-    @@api_key
+    configuration.api_key
   end
 
   # Sets the api key
@@ -46,6 +70,7 @@ module Shipcloud
   # @param [String] api_key The api key
   def self.api_key=(api_key)
     @@api_key = api_key
+    configuration.api_key = api_key
   end
 
   # Makes a request against the shipcloud API

data/lib/shipcloud/operations/delete.rb

@@ -0,0 +1,19 @@
+module Shipcloud
+  module Operations
+    module Delete
+      module ClassMethods
+        # Deletes the given object
+        #
+        # @param [String] id The id of the object that gets deleted
+        def delete(id)
+          response = Shipcloud.request(:delete, "#{self.name.split("::").last.downcase}s/#{id}", {})
+          true
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+    end
+  end
+end

data/lib/shipcloud/operations/update.rb

@@ -0,0 +1,28 @@
+module Shipcloud
+  module Operations
+    module Update
+
+      module ClassMethods
+        # Updates a object
+        # @param [String] id The id of the object that should be updated
+        # @param [Hash] attributes The attributes that should be updated
+        def update(id, attributes)
+          response = Shipcloud.request(:put, "#{self.name.split("::").last.downcase}s/#{id}", attributes)
+          self.new(response)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # Updates a object
+      #
+      # @param [Hash] attributes The attributes that should be updated
+      def update(attributes)
+        response = Shipcloud.request(:put, "#{self.class.name.split("::").last.downcase}s/#{id}", attributes)
+        set_attributes(response)
+      end
+    end
+  end
+end

data/lib/shipcloud/request/connection.rb

@@ -8,11 +8,16 @@ module Shipcloud
       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
+        if Shipcloud.configuration.use_ssl
+          @https             = Net::HTTP.new(Shipcloud.configuration.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")
+        else
+          @https             = Net::HTTP.new(Shipcloud.configuration.api_base, Net::HTTP.http_default_port)
+          @https.use_ssl     = false
+        end
+        @https.set_debug_output $stdout
       end
 
       def request

data/lib/shipcloud/request/validator.rb

@@ -11,8 +11,10 @@ module Shipcloud
       def validated_data_for(incoming_response)
         self.response = incoming_response
         verify_response_code
-        info.data = JSON.parse(response.body)
-        validate_response_data
+        if response.body
+          info.data = JSON.parse(response.body)
+          validate_response_data
+        end
         info.data
       end
 
@@ -24,7 +26,7 @@ module Shipcloud
       end
 
       def validate_response_data
-        raise APIError.new(info.data["error"]) if info.data["error"]
+        raise APIError.new(info.data["errors"]) if info.data["errors"]
       end
     end
   end

data/lib/shipcloud/shipment.rb

@@ -1,5 +1,7 @@
 module Shipcloud
   class Shipment < Base
+    include Shipcloud::Operations::Delete
+    include Shipcloud::Operations::Update
 
     attr_accessor :from, :to, :carrier, :package, :reference_number
     attr_reader :id, :created_at, :carrier_tracking_no, :tracking_url, :label_url, :packages, :price

data/lib/shipcloud/version.rb

@@ -1,3 +1,3 @@
 module Shipcloud
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/shipcloud/shipment_spec.rb

@@ -58,4 +58,18 @@ describe Shipcloud::Shipment do
       Shipcloud::Shipment.find("123")
     end
   end
+
+  describe ".update" do
+    it "makes a new PUT request using the correct API endpoint" do
+      Shipcloud.should_receive(:request).with(:put, "shipments/123", {:carrier => 'ups' }).and_return("data" => {})
+      Shipcloud::Shipment.update("123", {:carrier => 'ups' })
+    end
+  end
+
+  describe ".delete" do
+    it "makes a new DELETE request using the correct API endpoint" do
+      Shipcloud.should_receive(:request).with(:delete, "shipments/123", {}).and_return(true)
+      Shipcloud::Shipment.delete("123")
+    end
+  end
 end

data/spec/shipcloud_spec.rb

@@ -10,24 +10,69 @@ describe Shipcloud do
 
     context "with an invalid api key" do
       before(:each) do
-        WebMock.stub_request(:any, /#{Shipcloud::API_BASE}/).to_return(:body => "{}")
+        WebMock.stub_request(:any, /#{Shipcloud.configuration.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")
+        WebMock.should have_requested(:get, "https://#{Shipcloud::api_key}:@#{Shipcloud.configuration.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")
+        WebMock.should have_requested(:get, "https://#{Shipcloud::api_key}:@#{Shipcloud.configuration.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")
+        WebMock.should have_requested(:get, "https://#{Shipcloud::api_key}:@#{Shipcloud.configuration.api_base}/#{Shipcloud::API_VERSION}/transactions")
       end
     end
   end
+
+  describe '.configure' do
+    before :each do
+      Shipcloud.configuration = nil
+    end
+
+    it 'defaults api_key to nil' do
+      expect(Shipcloud.configuration.api_key).to be_nil
+    end
+
+    it 'sets the api_key' do
+      Shipcloud.configure do |config|
+        config.api_key = 'your-api-key'
+      end
+      expect(Shipcloud.configuration.api_key).to eq 'your-api-key'
+    end
+
+    it 'gets the api key, set as a class variable (DEPRECATED)' do
+      Shipcloud.api_key = 'old-school-api-key'
+      expect(Shipcloud.api_key).to eq 'old-school-api-key'
+      expect(Shipcloud.configuration.api_key).to eq 'old-school-api-key'
+    end
+
+    it "defaults api_base to 'api.shipcloud.io'" do
+      expect(Shipcloud.configuration.api_base).to eq 'api.shipcloud.io'
+    end
+
+    it 'overwrites the default api base' do
+      Shipcloud.configure do |config|
+        config.api_base = 'api.shipcloud.dev'
+      end
+      expect(Shipcloud.configuration.api_base).to eq 'api.shipcloud.dev'
+    end
+
+    it 'defaults use_ssl to true' do
+      expect(Shipcloud.configuration.use_ssl).to be_true
+    end
+
+    it 'overwrites the default ssl mode' do
+      Shipcloud.configure do |config|
+        config.use_ssl = false
+      end
+      expect(Shipcloud.configuration.use_ssl).to be_false
+    end
+  end
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: shipcloud
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - sthollmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2013-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -91,7 +82,9 @@ files:
 - lib/shipcloud.rb
 - lib/shipcloud/base.rb
 - lib/shipcloud/operations/create.rb
+- lib/shipcloud/operations/delete.rb
 - lib/shipcloud/operations/find.rb
+- lib/shipcloud/operations/update.rb
 - lib/shipcloud/request/base.rb
 - lib/shipcloud/request/connection.rb
 - lib/shipcloud/request/info.rb
@@ -108,27 +101,26 @@ files:
 homepage: https://github.com/webionate/shipcloud-ruby
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A wrapper for the shipcloud API
 test_files:
 - spec/shipcloud/request/base_spec.rb