bws 0.2.1.pre

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/Gemfile

@@ -0,0 +1,17 @@
+source :gemcutter
+
+gem 'httparty', '>= 0.6.1'
+gem 'builder', '>= 2.1.2'
+gem 'activesupport'
+gem 'i18n'
+
+group :development do
+  gem 'rake', '>= 0.9.2.2'
+  gem 'jeweler', '>= 1.6.4'
+end
+
+group :test do
+  gem 'shoulda', '2.11.3'
+  gem 'mocha', '0.9.8'
+  gem 'fakeweb',  '1.3.0'
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    crack (0.1.8)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    mocha (0.9.8)
+      rake
+    multi_json (1.3.5)
+    rake (0.9.2.2)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  builder (>= 2.1.2)
+  fakeweb (= 1.3.0)
+  httparty (>= 0.6.1)
+  i18n
+  jeweler (>= 1.6.4)
+  mocha (= 0.9.8)
+  rake (>= 0.9.2.2)
+  shoulda (= 2.11.3)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-11 Bookrenter Inc.
+
+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.rdoc

@@ -0,0 +1,116 @@
+== This Branch will be used by the half.com project. The changes will not be merged back to master unless requested by Bookrenter
+
+= Bookrenter Web Services Client
+
+The Bookrenter Web Services Client will let you connect and work with Bookrenter.com as an inventory provider and order fulfiller. This is a very early version of this library that has not yet been used in production.
+
+== Brief Info
+
+First, setup your client:
+
+  bws = BWSClient.new('api_key')
+  
+If you want to test on a different URL than the default of https://bws.bookrenter.com/v1, then you can pass in a separate base_uri like so:
+
+  bws = BWSClient.new('api_key', 'https://some.other-endpoint.com')
+
+=== Get Unacknowledged Orders
+
+  bws.unacknowledged_orders(page=1)
+  
+Returns an instance of BWS::UnacknowledgedOrders which you can then call .orders on to get the raw order hash, or .pages to get the total pages count
+
+TBD
+* Return an actual array of BWS::Order objects instead of the hash
+
+=== Get fillable orders
+
+  bws.fillable_orders(page=1)
+  
+Returns an instance of BWS::FillableOrders which you can then call .orders on to get the raw order hash, or .pages to get the total pages count
+
+TBD
+* Return an actual array of BWS::Order objects instead of the hash
+
+=== Get Order
+  
+  bws.order(public_id)
+  
+Returns a BWS::Order instance, which you can call .order on to get the actual data
+
+TBD
+* Make this not so redundant (eg my_order.order)
+* Return an actual BWS::Order object
+
+=== Acknowledge an Order
+
+  bws.acknowledge_order(order_hash)
+
+Returns a BWS::AcknowledgeOrder object which you can call .result? on to get success or failure
+
+order_hash should look like this:
+
+  {
+    "public_id"=>"BR-857D3F832",
+    "distributor_identifier" => 'your-order-id', # Optional
+    "distributor_line_items"=> {
+      "distributor_line_item"=> [
+        {
+          "public_id"=>"2FCA83283",
+          "status"=>"accepted",
+          "reject_reason"=>"Some reason", # Only required if status is rejected
+          "distributor_identifier" => 'your-line-item-id', # Optional
+          "estimated_ship_date" => "2010-08-09T17:23:12Z" # Optional
+        },
+        .... # more line items as needed
+      ]
+    }
+  }
+   
+Additional keys will be ignored. See the API documentation for more detail on the allowed values.
+
+=== Create a shipment
+
+  bws.create_shipment(shipment_hash)
+
+Returns a BWS::CreateShipment object which you can call .result? on to get success or failure
+
+shipment_hash should look like this:
+
+  {
+    "public_id" => 'BR-A06028299',
+    'estimated_delivery_date' => "2010-08-09T17:23:12Z", # Optional
+    'shipping_method' => 'Ground',
+    'shipped_at' => "2010-08-09T17:23:12Z", # Optional
+    'cost_cents' => '1000', # Optional
+    'carrier' => 'UPS',
+    'tracking_number' => '1Z12390128398123', # Optional
+    'distributor_line_items' => [{'public_id' => 'AB9DD69A4'}]
+  }
+   
+Additional keys will be ignored. See the API documentation for more detail on the allowed values.
+
+=== Reject a Line Item
+
+  bws.reject_line_item(line_item_hash)
+
+Returns a BWS::RejectLineItem object which you can call .result? on to get success or failure
+
+line_item_hash should look like this:
+
+  {
+    "public_id" => '1234',
+    'reject_reason' => "Some Reason"
+  }
+   
+Additional keys will be ignored. See the API documentation for more detail on the allowed values.
+
+
+== Running Tests
+
+gem install activesupport
+gem install i18n
+
+== Copyright
+
+Copyright (c) 2010-11 Bookrenter Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bws"
+    gem.summary = %Q{Interact with the Bookrenter Web Services API}
+    gem.description = %Q{Interact with the Bookrenter Web Services API}
+    gem.email = ["cameron.booth@bookrenter.com", "paolo.resmini@bookrenter.com"]
+    gem.homepage = "http://github.com/bkr/bws"
+    gem.authors = ["Cameron Booth", "Paolo Resmini"]
+    gem.add_dependency "httparty", ">= 0.6.1"
+    gem.add_dependency "builder", ">= 2.1.2"
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "fakeweb", ">= 0"
+    gem.add_development_dependency "mocha", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+Jeweler::GemcutterTasks.new
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+
+[{:type => "test:all", :folder => '**'}, {:type => "test:units", :folder => 'unit'}, {:type => "test:integration", :folder => 'integration'}, {:type => "test:functionals", :folder => 'functional'}].each do |test|
+  Rake::TestTask.new(test[:type]) do |t|
+    t.libs << 'lib' << 'test'
+    t.pattern = "test/#{test[:folder]}/test_*.rb"
+    t.verbose = true
+  end
+end
+
+task :default => ["test:all"]
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bws #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bws.gemspec

@@ -0,0 +1,133 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "bws"
+  s.version = "0.2.1.pre"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cameron Booth", "Paolo Resmini"]
+  s.date = "2013-11-27"
+  s.description = "Interact with the Bookrenter Web Services API"
+  s.email = ["cameron.booth@bookrenter.com", "paolo.resmini@bookrenter.com"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bws.gemspec",
+    "lib/bws.rb",
+    "lib/bws/acknowledge_order.rb",
+    "lib/bws/active_isbn_report.rb",
+    "lib/bws/checkout.rb",
+    "lib/bws/client.rb",
+    "lib/bws/create_shipment.rb",
+    "lib/bws/fillable_orders.rb",
+    "lib/bws/inventory.rb",
+    "lib/bws/order.rb",
+    "lib/bws/order_events.rb",
+    "lib/bws/orders.rb",
+    "lib/bws/reject_line_item.rb",
+    "lib/bws/response.rb",
+    "lib/bws/unacknowledged_orders.rb",
+    "test/fixtures/acknowledge_success.xml",
+    "test/fixtures/active_isbn_report_with_one_isbn_request_body.xml",
+    "test/fixtures/active_isbn_report_with_one_isbn_success.xml",
+    "test/fixtures/active_isbn_report_with_two_isbns_request_body.xml",
+    "test/fixtures/active_isbn_report_with_two_isbns_success.xml",
+    "test/fixtures/cancel_line_item_success.xml",
+    "test/fixtures/create_order_request_body.xml",
+    "test/fixtures/create_order_response_success.xml",
+    "test/fixtures/create_shipment_success.xml",
+    "test/fixtures/fillable_success.xml",
+    "test/fixtures/inventory_by_isbn_success.xml",
+    "test/fixtures/inventory_success.xml",
+    "test/fixtures/order_events_by_order_success.xml",
+    "test/fixtures/order_events_success.xml",
+    "test/fixtures/order_success.xml",
+    "test/fixtures/orders_show_success.xml",
+    "test/fixtures/price_order_request_body.xml",
+    "test/fixtures/price_order_response_success.xml",
+    "test/fixtures/single_post_create_order_request_body.xml",
+    "test/fixtures/single_post_create_order_response_success.xml",
+    "test/fixtures/unacknowledged_success.xml",
+    "test/fixtures/unacknowledged_success_0_orders.xml",
+    "test/fixtures/unacknowledged_success_1_order.xml",
+    "test/fixtures/validate_credit_card_request_body.xml",
+    "test/fixtures/validate_credit_card_response_success.xml",
+    "test/helper.rb",
+    "test/integration/test_bws_active_isbn_report.rb",
+    "test/integration/test_bws_retrieve_inventory.rb",
+    "test/unit/test_bws_acknowledge_order.rb",
+    "test/unit/test_bws_active_isbn_report.rb",
+    "test/unit/test_bws_checkout.rb",
+    "test/unit/test_bws_client.rb",
+    "test/unit/test_bws_create_shipment.rb",
+    "test/unit/test_bws_fillable_orders.rb",
+    "test/unit/test_bws_order.rb",
+    "test/unit/test_bws_reject_line_item.rb",
+    "test/unit/test_bws_response.rb",
+    "test/unit/test_bws_retrieve_inventory.rb",
+    "test/unit/test_bws_retrieve_inventory_by_isbn.rb",
+    "test/unit/test_bws_retrieve_order_events.rb",
+    "test/unit/test_bws_retrieve_order_events_by_order.rb",
+    "test/unit/test_bws_unacknowledged_orders.rb",
+    "test/unit/test_retrieve_orders_show.rb"
+  ]
+  s.homepage = "http://github.com/bkr/bws"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Interact with the Bookrenter Web Services API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0.9.2.2"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0.9.2.2"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.6.1"])
+    s.add_dependency(%q<builder>, [">= 2.1.2"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0.9.2.2"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+    s.add_dependency(%q<httparty>, [">= 0.6.1"])
+    s.add_dependency(%q<builder>, [">= 2.1.2"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/lib/bws.rb

@@ -0,0 +1,13 @@
+require 'bws/client'
+require 'bws/response'
+require 'bws/unacknowledged_orders'
+require 'bws/fillable_orders'
+require 'bws/order'
+require 'bws/acknowledge_order'
+require 'bws/create_shipment'
+require 'bws/reject_line_item'
+require 'bws/inventory'
+require 'bws/order_events'
+require 'bws/checkout'
+require 'bws/orders'
+require 'bws/active_isbn_report'

data/lib/bws/acknowledge_order.rb

@@ -0,0 +1,11 @@
+class BWS::AcknowledgeOrder < BWS::Response
+
+  def result
+    base.nil?
+  end
+
+private
+  def base
+    response.parsed_response['envelope']['body']['distributor_orders_acknowledge']
+  end
+end

data/lib/bws/active_isbn_report.rb

@@ -0,0 +1,27 @@
+class BWS::ActiveIsbnReport < BWS::Response
+  def result
+    base.nil?
+  end
+
+  def active_isbns
+    return active_isbn_report['active_isbns']['active_isbn'] if active_isbn_report && active_isbn_report['active_isbns'] && active_isbn_report['active_isbns']['active_isbn'].class == Array
+
+    return [ active_isbn_report['active_isbns']['active_isbn'] ] if active_isbn_report && active_isbn_report['active_isbns'] && active_isbn_report['active_isbns']['active_isbn'].class == Hash
+
+    return []
+  end
+
+  def pagination
+    base['pagination']
+  end
+
+  private
+
+  def active_isbn_report
+    base['active_isbn_report']
+  end
+
+  def base
+    response.parsed_response['envelope']['body']['reports_active_isbn_report']
+  end
+end