rafter-fulfillment 1.0.0

data/lib/fulfillment/search_exception.rb

@@ -0,0 +1,5 @@
+module Fulfillment
+  class SearchException < ClientException
+
+  end
+end

data/lib/fulfillment/shipment.rb

@@ -0,0 +1,100 @@
+module Fulfillment
+  class Shipment < ModelBase
+
+    attr_accessor :client
+
+    def initialize(client, data)
+      @client = client
+      make_getter_methods(data)
+    end
+
+    def shipment_items(first_page_num = 1)
+      Fulfillment::Shipment.shipment_items(self.client, self.public_id, first_page_num)
+    end
+    
+    def add(shipment_items_array)
+      Fulfillment::Shipment.add(self.client, self.fulfillment_order['id'], self.public_id, shipment_items_array)
+    end
+
+    def close
+      Fulfillment::Shipment.close(self.client, self.fulfillment_order['id'], self.public_id)
+    end
+
+    class << self
+
+      def add(client, order_public_id, shipment_public_id, shipment_items_array)
+        shipment_payload = { "fulfillment_order_items" => shipment_items_array }
+        curl = Curl::Easy.http_put(client.build_auth_url("/orders/#{order_public_id}/shipments/#{shipment_public_id}/add"), shipment_payload.to_json) do |curl|
+          client.configure_http(curl)
+        end
+
+        raise Fulfillment::ClientException.new("Could not add shipment information about shipment #{shipment_public_id} to order #{order_public_id}:\n\n Response Body:\n #{curl.body_str}") unless curl.response_code == 200
+
+        new(client, JSON.parse(curl.body_str))
+      end
+
+      def create(client, order_public_id, shipment_hash)
+        curl = Curl::Easy.http_post(client.build_auth_url("/orders/#{order_public_id}/shipments"), shipment_hash.to_json) do |curl|
+          client.configure_http(curl)
+        end
+
+        raise Fulfillment::CreationException.new("Could not create shipment for order #{order_public_id}:\n\n Response Body:\n #{curl.body_str}") unless curl.response_code == 201
+
+        new(client, JSON.parse(curl.body_str))
+      end
+
+      def shipment_items(client, shipment_public_id, first_page_num = 1)
+        Fulfillment::PagedResult.construct(first_page_num) do |page_num|
+          curl = Curl::Easy.http_get(client.build_auth_url("/shipments/#{shipment_public_id}/items")) do |curl|
+            client.configure_http(curl)
+            client.set_request_page(curl, page_num)
+          end
+
+          raise Fulfillment::ClientException.new("Could not load index of items for shipment #{shipment_public_id}: \n\n Response Body:\n #{curl.body_str}") unless curl.response_code == 200
+
+          shipment_items_hashes = JSON.parse(curl.body_str)
+          result = shipment_items_hashes.map { |sh| Fulfillment::ShipmentItem.new(client, sh) }
+
+          Fulfillment::PagingEnvelope.envelop(curl, result)
+        end
+      end
+
+      def show(client, shipment_public_id)
+        curl = Curl::Easy.http_get(client.build_auth_url("/shipments/#{shipment_public_id}")) do |curl|
+          client.configure_http(curl)
+        end
+
+        raise Fulfillment::ClientException.new("Could not get shipment #{shipment_public_id}:\n\n Response Body:\n #{curl.body_str}") unless curl.response_code == 200
+
+        new(client, JSON.parse(curl.body_str))
+      end
+
+      def list(client, first_page_num = 1)
+        Fulfillment::PagedResult.construct(first_page_num) do |page_num|
+          curl = Curl::Easy.http_get(client.build_auth_url("/shipments")) do |curl|
+            client.configure_http(curl)
+            client.set_request_page(curl, page_num)
+          end
+        
+          raise Fulfillment::ClientException.new("Could not get index of shipments:\n\n Response Body:\n #{curl.body_str}") unless curl.response_code == 200
+        
+          shipment_hashes = JSON.parse(curl.body_str)
+          result = shipment_hashes.map { |sh| new(client, sh) }
+          
+          Fulfillment::PagingEnvelope.envelop(curl, result)
+        end  
+      end
+
+      def close(client, order_public_id, shipment_public_id)
+        curl = Curl::Easy.http_put(client.build_auth_url("/orders/#{order_public_id}/shipments/#{shipment_public_id}/close"), {}.to_json) do |curl|
+          client.configure_http(curl)
+        end
+
+        raise Fulfillment::ClientException.new("Could not close shipment #{shipment_public_id} for order #{order_public_id}:\n\n Response Body:\n #{curl.body_str}") unless curl.response_code == 200
+
+        new(client, JSON.parse(curl.body_str))
+      end
+      
+    end
+  end
+end

data/lib/fulfillment/shipment_item.rb

@@ -0,0 +1,9 @@
+module Fulfillment
+  class ShipmentItem < ModelBase
+
+    def initialize(client, data)
+      @client = client
+      make_getter_methods(data)
+    end
+  end
+end

data/lib/fulfillment/version.rb

@@ -0,0 +1,5 @@
+module Fulfillment
+  VERSION = "1.0.0"
+
+  API_VERSION = "application/vnd.rafter-fulfillment-v1+json"
+end

data/lib/rafter-fulfillment.rb

@@ -0,0 +1,21 @@
+require 'json'
+require 'curb'
+require 'openssl'
+require 'active_support/core_ext/hash/indifferent_access'
+
+%w(
+  client
+  client_exception
+  creation_exception
+  model_base
+  order
+  order_item
+  paged_result
+  paging_envelope
+  search_exception
+  shipment
+  shipment_item
+  version
+).each do |file|
+  require File.join(File.dirname(__FILE__), 'fulfillment', file)
+end

data/rafter-fulfillment.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fulfillment/version'
+
+Gem::Specification.new do |spec|
+  spec.name           = "rafter-fulfillment"
+  spec.version        = Fulfillment::VERSION
+  spec.authors        = ["Michael Pearce", "Paolo Resmini", "Dudley Chamberlin", "Peter Myers", "Nick Zalabak", "Mike 'sealabcore' Taylor"]
+  spec.email          = ["exchange-engineers@rafter.com"]
+  spec.homepage       = "https://github.com/bkr/rafter-fulfillment"
+  spec.summary        = "Client for the Rafter Fulfillment API"
+  spec.license        = "Apache 2.0"
+
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ["~> 2.11.0"]
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "faker"
+
+  spec.add_runtime_dependency "curb"
+  spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "activesupport"
+end

data/spec/client_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Fulfillment::Client do
+  before :each do
+    @client = Fulfillment::Client.new(:host => "fulfillment-test.rafter.com", :api_key => "xyz123abc")
+  end
+  
+  it 'makes the host and api_key a readable attribute' do
+    @client.host.should eq "fulfillment-test.rafter.com"
+    @client.api_key.should eq "xyz123abc"
+  end
+
+  it 'returns the base URI' do
+    @client.base_uri.should eq "https://fulfillment-test.rafter.com"
+  end
+
+  it 'raises an ArgumentError if the host argument is missing' do
+    lambda { Fulfillment::Client.new(:api_key => "xyz123abc") }.should raise_error(ArgumentError, ":host is a required argument")
+  end
+
+  it 'raises an ArgumentError if the api_key argument is missing' do
+    lambda { Fulfillment::Client.new(:host => "exchange-test.rafter.com") }.should raise_error(ArgumentError, ":api_key is a required argument")
+  end
+  
+  it 'raises a TimeoutError if the timeout is exceeded' do
+    lambda {
+      @client = Fulfillment::Client.new(:host => '10.201.202.203', :api_key => @client.api_key, :timeout => 1)
+      Fulfillment::Order.show(@client, 'TEST42')      
+    }.should raise_error(Curl::Err::TimeoutError)
+  end
+  
+  describe ".build_auth_url" do
+    it 'builds correct auth url with api_key' do
+      @client.build_auth_url("/bin").should eq "https://fulfillment-test.rafter.com/bin"
+    end
+  end
+  
+  describe ".set_request_page" do
+    it 'adds page parameter to url' do
+      curl = Curl::Easy.new(@client.build_auth_url("/base_url"))
+      @client.set_request_page(curl, 12).should eq "https://fulfillment-test.rafter.com/base_url?page=12"
+      curl.url.should eq "https://fulfillment-test.rafter.com/base_url?page=12"
+    end
+  end
+  
+  describe ".add_query_parameter" do
+    it 'adds query parameter to url when no parameters existed' do
+      curl = Curl::Easy.new("https://fulfillment-test.rafter.com/base_url")
+      @client.add_query_parameter(curl, "dummy_key", "dummy_value").should eq "https://fulfillment-test.rafter.com/base_url?dummy_key=dummy_value"
+      curl.url.should eq "https://fulfillment-test.rafter.com/base_url?dummy_key=dummy_value"
+    end
+
+    it 'adds query parameter to url when parameters existed' do
+      curl = Curl::Easy.new(@client.build_auth_url("/base_url"))
+      @client.add_query_parameter(curl, "dummy_key", "dummy_value").should eq "https://fulfillment-test.rafter.com/base_url?dummy_key=dummy_value"
+      curl.url.should eq "https://fulfillment-test.rafter.com/base_url?dummy_key=dummy_value"
+    end
+    
+    it 'escapes unfriendly characters' do
+      client = Fulfillment::Client.new(:host => "fulfillment-test.rafter.com", :api_key => "xyz123abc")
+      curl = Curl::Easy.new(client.build_auth_url("/base_url"))
+      client.add_query_parameter(curl, "dummy key", "dummy value").should eq "https://fulfillment-test.rafter.com/base_url?dummy+key=dummy+value"
+    end
+  end
+end

data/spec/order_item_spec.rb

@@ -0,0 +1,207 @@
+require 'spec_helper'
+
+describe Fulfillment::OrderItem do
+  before :each do
+    @client = Fulfillment::Client.new(:api_key => '12345', :host => 'localhost:3000', :scheme => 'http')
+
+    @order_public_id = 'FO-gobbledeg0123456'
+  end
+
+  describe ".list" do
+    before :each do
+      @response_json = <<-END
+      [
+        {
+          "public_id":"FOI0d9932",
+          "created_at":"2012-12-07T00:07:43-08:00",
+          "updated_at":"2012-12-07T00:09:20-08:00",
+          "fulfillable_id":3493,
+          "fulfillable_type":"BookInstance",
+          "rejected":false,
+          "rejected_code":null,
+          "quantity_accepted":2,
+          "quantity_rejected":3,
+          "fulfillment_shipments":[{
+                      "public_id":"FSee4e3d829a183c21",
+                      "location":"/shipments/FSee4e3d829a183c21"
+                    }]
+        },
+        {
+          "public_id":"FOIc2da7f",
+          "created_at":"2012-12-07T00:07:43-08:00",
+          "updated_at":"2012-12-07T00:09:20-08:00",
+          "fulfillable_id":4611,
+          "fulfillable_type":"BookInstance",
+          "rejected":false,
+          "rejected_code":null,
+          "quantity_accepted":2,
+          "quantity_rejected":3,
+          "fulfillment_shipments":[{
+                      "public_id":"FSee4e3d829a183c21",
+                      "location":"/shipments/FSee4e3d829a183c21"
+                    }]
+        }
+      ]
+      END
+      @curl = double( 'curl', :response_code => 200,
+                              :body_str => @response_json,
+                              :header_str => "HTTP/1.1 200 OK\r\nX-API-PAGINATION: {\"per_page\":100,\"total_pages\":1}")
+    end
+
+    it 'should return a list of order items' do
+      Curl::Easy.should_receive(:http_get).with("http://localhost:3000/orders/#{@order_public_id}/items").and_return(@curl)
+      order_items = Fulfillment::OrderItem.list(@client, @order_public_id)
+      order_items.should be_a Fulfillment::PagedResult
+      results = order_items.results
+      results.size.should eq 2
+      results.first.should be_a Fulfillment::OrderItem
+    end
+  end
+
+  describe ".show" do
+    before :each do
+      @order_item_public_id = "FOI1234567890"
+      @response_json = <<-END
+      {
+        "public_id":"#{@order_item_public_id}",
+        "created_at":"2012-12-07T00:07:43-08:00",
+        "updated_at":"2012-12-07T00:09:20-08:00",
+        "fulfillable_id":3493,
+        "fulfillable_type":"BookInstance",
+        "rejected":false,
+        "rejected_code":null,
+        "quantity_accepted":2,
+        "quantity_rejected":3,
+        "fulfillment_shipments":[{
+                  "public_id":"FSee4e3d829a183c21",
+                  "location":"/shipments/FSee4e3d829a183c21"
+                }]
+      }
+      END
+
+      @curl = double( 'curl', :response_code => 200,
+                              :body_str => @response_json)
+    end
+
+    it 'should return an individual order item' do
+      Curl::Easy.should_receive(:http_get).with("http://localhost:3000/orders/#{@order_public_id}/items/#{@order_item_public_id}").and_return(@curl)
+      order_item_result = Fulfillment::OrderItem.show(@client, @order_public_id, @order_item_public_id)
+      order_item_result.should be_a Fulfillment::OrderItem
+      order_item_result.public_id.should eq @order_item_public_id
+    end
+  end
+
+  describe ".acknowledge" do
+    context "with valid keys" do
+      before :each do
+        @order_item_id = 'FOI517513'
+        @response_json = <<-END
+        {
+          "public_id":"#{@order_item_id}",
+          "created_at":"2012-12-05T16:28:23-08:00",
+          "updated_at":"2012-12-05T16:28:23-08:00",
+          "fulfillable_id":3493,
+          "fulfillable_type":"BookInstance",
+          "rejected":false,
+          "rejected_code":null,
+          "quantity_accepted":2,
+          "quantity_rejected":3,
+          "fulfillment_shipments":[]
+        }
+        END
+
+        @curl = double( 'curl', :response_code => response_code,
+                                :body_str => @response_json,
+                                :header_str => "HTTP/1.1 200 OK\r\nX-API-PAGINATION: {\"per_page\":100,\"total_pages\":1}")
+      end
+
+      context "returns 500" do
+        let(:response_code) { 500 }
+
+        it 'should raise error' do
+          Curl::Easy.should_receive(:http_put).with("http://localhost:3000/orders/#{@order_public_id}/items/#{@order_item_id}/acknowledge", {"quantity_accepted" => 2, "quantity_rejected" => 1}.to_json).and_return(@curl)
+          expect{Fulfillment::OrderItem.acknowledge(@client, @order_public_id, @order_item_id, {"quantity_accepted" => 2, "quantity_rejected" => 1})}.to raise_error(Fulfillment::CreationException)
+        end
+      end
+
+      context "returns 200" do
+        let(:response_code) { 200 }
+
+        it 'should return the order item with acknowledgements' do
+          Curl::Easy.should_receive(:http_put).with("http://localhost:3000/orders/#{@order_public_id}/items/#{@order_item_id}/acknowledge", {"quantity_accepted" => 2, "quantity_rejected" => 1}.to_json).and_return(@curl)
+          order_item = Fulfillment::OrderItem.acknowledge(@client, @order_public_id, @order_item_id, {"quantity_accepted" => 2, "quantity_rejected" => 1})
+          order_item.quantity_accepted.should eq 2
+          order_item.quantity_rejected.should eq 3
+        end
+      end
+    end
+
+    context "without valid keys" do
+      it 'should return the order item with acknowledgements' do
+        Curl::Easy.should_receive(:http_put).never
+        expect {Fulfillment::OrderItem.acknowledge(@client, @order_public_id, @order_item_id, {"quantity_accepted" => 2})}.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe ".reject" do
+    before :each do
+      @order_item_id = 'FOI517513'
+      @response_json = <<-END
+      {
+        "public_id":"#{@order_item_id}",
+        "created_at":"2012-12-05T16:28:23-08:00",
+        "updated_at":"2012-12-05T16:28:23-08:00",
+        "fulfillable_id":2777,
+        "fulfillable_type":"BookInstance",
+        "status":"rejected",
+        "rejected_code":2,
+        "quantity_accepted":2,
+        "quantity_rejected":3,
+        "fulfillment_shipments":[]
+      }
+      END
+
+      @curl = double( 'curl', :response_code => 200,
+                              :body_str => @response_json,
+                              :header_str => "HTTP/1.1 200 OK\r\nX-API-PAGINATION: {\"per_page\":100,\"total_pages\":1}")
+    end
+
+    it 'should return the order item with a rejected status' do
+      Curl::Easy.should_receive(:http_put).with("http://localhost:3000/orders/#{@order_public_id}/items/#{@order_item_id}/reject", {'rejected_code' => 2}.to_json).and_return(@curl)
+      order_item = Fulfillment::OrderItem.reject(@client, @order_public_id, @order_item_id, 2)
+      order_item.status.should eq 'rejected'
+      order_item.rejected_code.should eq 2
+    end
+  end
+
+  describe ".process" do
+    before :each do
+      @order_item_id = 'FOI517513'
+      @response_json = <<-END
+      {
+        "public_id":"#{@order_item_id}",
+        "created_at":"2012-12-05T16:28:23-08:00",
+        "updated_at":"2012-12-05T16:28:23-08:00",
+        "fulfillable_id":2777,
+        "fulfillable_type":"BookInstance",
+        "status":"processing",
+        "quantity_accepted":2,
+        "quantity_rejected":3,
+        "fulfillment_shipments":[]
+      }
+      END
+
+      @curl = double( 'curl', :response_code => 200,
+                              :body_str => @response_json,
+                              :header_str => "HTTP/1.1 200 OK\r\nX-API-PAGINATION: {\"per_page\":100,\"total_pages\":1}")
+    end
+
+    it 'should return the order item with a processing status' do
+      Curl::Easy.should_receive(:http_put).with("http://localhost:3000/orders/#{@order_public_id}/items/#{@order_item_id}/process", {}).and_return(@curl)
+      order_item = Fulfillment::OrderItem.process(@client, @order_public_id, @order_item_id)
+      order_item.status.should eq 'processing'
+    end
+  end
+
+end