oshpark 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93f9cb0eba00704df61db79967ffa89ec46e7960
-  data.tar.gz: d33415dc53c8bb71cf26efd1e22fddc0ca6fab8e
+  metadata.gz: 5d5f25d87af7fa429c3ac0963ccc7f02ece62a68
+  data.tar.gz: f514b160f998dbe1c329bbf43d1aa1ca93ce2ff3
 SHA512:
-  metadata.gz: 252709f29aa94bd1dae99f4abc95e50391aaae965ed22096903a6b4e38f65ad943173890f0172a7ab8593688e2e9a551ea9ee0e383b80ff1c044e2af6d1b75b0
-  data.tar.gz: 50971cd5dd49b431937e8f1fb0eb5ffa720f16f1ef0dd32f057511a9151658c9885fbfbbf66455b1a0f566cdf12dfdb82bb6950e2c1caecc2c5839293be3e008
+  metadata.gz: d465cfa91e925af53618e94d84694ac03e4de28b9899e5563cbc76651b37b2bb6b8d160468bb87ebaebb111250e4b878465c2c0a67933ffac6175f33036598fc
+  data.tar.gz: fb3ac304346a04ff83ae49d325932146315df8d5ef2a36c854b1a112d90bec1d040e4185523fb4f00b7a0a7913522370e612cf942873a4b2b58ba41d23671366

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oshpark (0.0.5)
+    oshpark (0.0.7)
       micro_token
       thor
 

data/lib/oshpark.rb

@@ -3,6 +3,7 @@ require "oshpark/ext"
 require "oshpark/client"
 require "oshpark/connection"
 require "oshpark/model"
+require "oshpark/stateful"
 require "oshpark/dimensionable"
 require "oshpark/order_option"
 require "oshpark/project"

data/lib/oshpark/address.rb

@@ -10,11 +10,7 @@ module Oshpark
     attrs.each {|a| attr_accessor a }
 
     def initialize args={}
-      args = check_args args
-      Address.attrs.each do |a|
-        v = args.fetch(a, nil)
-        public_send :"#{a}=", v
-      end
+      super check_args args
     end
 
     def to_h
@@ -31,16 +27,8 @@ module Oshpark
       unless (args.keys.map(&:to_s) & REQUIRED_ARGS) == REQUIRED_ARGS
         raise ArgumentError, "Missing required arguments #{(REQUIRED_ARGS - args.keys).join(' ')}"
       end
-
-      stingify_hash_keys args
+      args
     end
 
-    def stingify_hash_keys hash
-      {}.tap do |h|
-        hash.each do |k, v|
-          h[k.to_s] = v
-        end
-      end
-    end
   end
 end

data/lib/oshpark/client.rb

@@ -108,7 +108,11 @@ module Oshpark
     # @param id
     # @param address
     def set_order_address id, address
-      put_request "orders/#{id}/set_address", address.to_h
+      put_request "orders/#{id}/set_address", address
+    end
+
+    def shipping_rates address_params
+      post_request "shipping_rates", {address: address_params}
     end
 
     # Set the delivery address for an Order

data/lib/oshpark/connection.rb

@@ -73,7 +73,6 @@ module Oshpark
       header
     end
 
-
     def prepare_params params
       if params.keys.include? :file
         params.to_multipart

data/lib/oshpark/import.rb

@@ -4,10 +4,13 @@ module Oshpark
       %w| id state original_url original_filename error_message queued_at started_at completed_at errored_at failed_at project_id |
     end
 
+    STATES = %w| WAITING RUNNING SUCCESS ERROR FAILED |
+
     include Model
+    include Stateful
 
     def self.create url
-      self.from_json(Oshpark::client.create_import(url))
+      self.from_json(Oshpark::client.create_import(url)['import'])
     end
 
     def project

data/lib/oshpark/order.rb

@@ -1,6 +1,8 @@
 module Oshpark
   class Order
 
+    STATES = %w| EMPTY NEW RECEIVED PROCESSING SHIPPED CANCELLED |
+
     def self.attrs
       %w| id board_cost cancellation_reason cancelled_at ordered_at
           payment_provider payment_received_at project_name quantity
@@ -10,29 +12,30 @@ module Oshpark
     end
 
     include Model
+    include Stateful
 
     def self.create
-      self.from_json(Oshpark::client.create_order)
+      self.from_json(Oshpark::client.create_order['order'])
     end
 
     def add_item order_item, quantity
       json = Oshpark::client.add_order_item id, order_item.id, quantity
-      reload_with json
+      reload_with json['order']
     end
 
     def set_address address
       json = Oshpark::client.set_order_address id, address
-      reload_with json
+      reload_with json['order']
     end
 
     def set_shipping_rate carrier_name, service_name
       json = Oshpark::client.set_order_shipping_rate id, carrier_name, service_name
-      reload_with json
+      reload_with json['order']
     end
 
     def checkout
       json = Oshpark::client.checkout_order id
-      reload_with json
+      reload_with json['order']
     end
 
     def panel

data/lib/oshpark/order_item.rb

@@ -1,11 +1,15 @@
 module Oshpark
   class OrderItem
+
+    STATES = %w| NEW AWAITING_PANEL PANELIZED ORDERED FABBED SHIPPED CANCELLED |
+
     def self.attrs
       %w| name batches batch_cost sub_total price quantity state confirmed_at panelized_at
           ordered_at fabbed_at shipped_at project_id panel_id order_item_option_selections |
     end
 
     include Model
+    include Stateful
 
     def project
       Oshpark::Project.find @project_id if @project_id

data/lib/oshpark/panel.rb

@@ -1,5 +1,7 @@
 module Oshpark
   class Panel
+    STATES = %w| OPEN ORDERED RECEIVED |
+
     def self.attrs
       %w| pcb_layers scheduled_order_time expected_receive_time
           id ordered_at received_at state service total_orders
@@ -7,6 +9,7 @@ module Oshpark
     end
 
     include Model
+    include Stateful
 
     def scheduled_order_time
       time_from @scheduled_order_time if @scheduled_order_time

data/lib/oshpark/project.rb

@@ -1,5 +1,7 @@
 module Oshpark
   class Project
+    STATES = %w| NEW APPROVED AWAITING_REMOVAL |
+
     def self.attrs
       %w| id design_file_url name description top_image bottom_image width_in_mils height_in_mils pcb_layers state layers order_options is_shared |
     end
@@ -9,6 +11,7 @@ module Oshpark
     end
 
     include Model
+    include Stateful
     include Dimensionable
 
     alias shared? is_shared
@@ -43,7 +46,7 @@ module Oshpark
 
     def approve!
       json = Oshpark::client.approve_project id
-      reload_with(json)
+      reload_with(json['project'])
     end
 
   end

data/lib/oshpark/shipping_rate.rb

@@ -7,5 +7,12 @@ module Oshpark
 
     include Model
 
+    def self.rates_for_address address
+      json = Oshpark::client.shipping_rates address.to_h
+
+      json['shipping_rates'].collect do |shipping_rate_json|
+        self.from_json shipping_rate_json
+      end
+    end
   end
 end

data/lib/oshpark/stateful.rb

@@ -0,0 +1,11 @@
+module Oshpark
+  module Stateful
+    def self.included base
+      base.const_get(:STATES).each do |_state|
+        define_method "#{_state.downcase}?" do
+          state == _state
+        end
+      end
+    end
+  end
+end

data/lib/oshpark/upload.rb

@@ -4,16 +4,27 @@ module Oshpark
       %w| id state original_filename error_message queued_at started_at completed_at errored_at failed_at project_id |
     end
 
+    STATES = %w| WAITING RUNNING SUCCESS ERROR FAILED |
+
     include Model
+    include Stateful
 
     def self.create file
-      self.from_json(Oshpark::client.create_upload(file))
+      self.from_json(Oshpark::client.create_upload(file)['upload'])
     end
 
     def project
       Project.find project_id
     end
 
+    def processing?
+      waiting? || running?
+    end
+
+    def finished?
+      success? || error? || failed?
+    end
+
     def queued_at
       time_from @queued_at
     end

data/lib/oshpark/version.rb

@@ -1,3 +1,3 @@
 module Oshpark
-  VERSION = "0.0.5"
+  VERSION = "0.0.7"
 end

data/spec/lib/oshpark/client_spec.rb

@@ -88,13 +88,22 @@ describe Oshpark::Client do
 
   describe '#set_order_address' do
     let(:token)   { 'abcd1234' }
-    let(:address) { Oshpark::Address.new name: "Bob", address_line_1: "8 Nelson Street", address_line_2: "Petone",  city: "Lower Hutt", country: "New Zealand" }
+    let(:address) { {"name" => "Bob", "company_name" => nil, "address_line_1" => "8 Nelson Street", "address_line_2" => "Petone", "city" => "Lower Hutt", "state" => nil, "zip_or_postal_code" => nil, "country" => "New Zealand", "phone_number" => nil, "is_business" => nil} }
     it "set the delivery address for an order" do
       subject.set_order_address token, address
       expect(connection.requests.last).to eq([:put, "orders/#{token}/set_address", {"name" => "Bob", "company_name" => nil, "address_line_1" => "8 Nelson Street", "address_line_2" => "Petone", "city" => "Lower Hutt", "state" => nil, "zip_or_postal_code" => nil, "country" => "New Zealand", "phone_number" => nil, "is_business" => nil}])
     end
   end
 
+  describe "#shipping_rates" do
+    let(:token)   { 'abcd1234' }
+    let(:address) { {"name" => "Bob", "company_name" => nil, "address_line_1" => "8 Nelson Street", "address_line_2" => "Petone", "city" => "Lower Hutt", "state" => nil, "zip_or_postal_code" => nil, "country" => "New Zealand", "phone_number" => nil, "is_business" => nil} }
+    it "returns shipping rates" do
+      subject.shipping_rates address
+      expect(connection.requests.last).to eq([:post, "shipping_rates", {:address => {"name" => "Bob", "company_name" => nil, "address_line_1" => "8 Nelson Street", "address_line_2" => "Petone", "city" => "Lower Hutt", "state" => nil, "zip_or_postal_code" => nil, "country" => "New Zealand", "phone_number" => nil, "is_business" => nil}}])
+    end
+  end
+
   describe '#set_order_shipping_rate' do
     let(:token)            { 'abcd1234' }
     let(:service_provider) { 'Bobs Mail'}

data/spec/lib/oshpark/order_spec.rb

@@ -29,7 +29,7 @@ describe Oshpark::Order do
   end
 
   describe '.create' do
-    before { expect(Oshpark::client).to receive(:create_order).and_return({id: "abcd1234", state: 'New'}) }
+    before { expect(Oshpark::client).to receive(:create_order).and_return({'order' => {id: "abcd1234", state: 'New'}}) }
     subject { Oshpark::Order.create }
 
     it 'creates a new Order' do
@@ -49,7 +49,7 @@ describe Oshpark::Order do
       allow(subject).to receive(:id).and_return('abcd1234')
 
       expect(item).to receive(:id).and_return('1234abcd')
-      expect(Oshpark::client).to receive(:add_order_item).with("abcd1234", "1234abcd", 6).and_return({id: "abcd1234"})
+      expect(Oshpark::client).to receive(:add_order_item).with("abcd1234", "1234abcd", 6).and_return({'order' => {id: "abcd1234"}})
       subject.add_item item, quantity
     end
   end
@@ -59,18 +59,18 @@ describe Oshpark::Order do
     it 'sets the delivery Address for an Order' do
       allow(subject).to receive(:id).and_return('abcd1234')
 
-      expect(Oshpark::client).to receive(:set_order_address).with("abcd1234", address).and_return({id: "abcd1234"})
+      expect(Oshpark::client).to receive(:set_order_address).with("abcd1234", address).and_return({'order' => {id: "abcd1234"}})
       subject.set_address address
     end
   end
 
   describe '#set_shipping_rate' do
     let(:carrier_name) { 'Bobs Mail'}
-    let(:service_name)     { 'Overnight Delivery' }
+    let(:service_name) { 'Overnight Delivery' }
     it 'sets the shipping rate for an Order' do
       allow(subject).to receive(:id).and_return('abcd1234')
 
-      expect(Oshpark::client).to receive(:set_order_shipping_rate).with("abcd1234", "Bobs Mail", "Overnight Delivery").and_return({id: "abcd1234"})
+      expect(Oshpark::client).to receive(:set_order_shipping_rate).with("abcd1234", "Bobs Mail", "Overnight Delivery").and_return({'order' => {id: "abcd1234"}})
       subject.set_shipping_rate carrier_name, service_name
     end
   end
@@ -79,7 +79,7 @@ describe Oshpark::Order do
     it 'checks out the order' do
       allow(subject).to receive(:id).and_return('abcd1234')
 
-      expect(Oshpark::client).to receive(:checkout_order).and_return({id: "abcd1234"})
+      expect(Oshpark::client).to receive(:checkout_order).and_return({'order' => {id: "abcd1234"}})
       subject.checkout
     end
   end

data/spec/lib/oshpark/shipping_rate_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Oshpark::ShippingRate do
+  before do
+    Oshpark::client url: 'blarg',  connection: FakeClient.new("foo")
+  end
+
+  subject { Oshpark::ShippingRate.new({}) }
+  it { should be_an Oshpark::Model }
+
+  describe 'rates_for_address' do
+    let(:address_params) { {name: "Bob", address_line_1: "8 Nelson Street", address_line_2: "Petone",  city: "Lower Hutt", country: "New Zealand"} }
+    let(:address) { Oshpark::Address.new address_params }
+    subject { Oshpark::ShippingRate.rates_for_address address }
+
+    before do
+      expect(Oshpark::client).to receive(:shipping_rates).
+        with({"name" => "Bob", "company_name" => nil, "address_line_1" => "8 Nelson Street", "address_line_2" => "Petone", "city" => "Lower Hutt", "state" => nil, "zip_or_postal_code" => nil, "country" => "New Zealand", "phone_number" => nil, "is_business" => nil}).
+        and_return({'shipping_rates' => [:carrier_name => "Pete's Post", :service_name => "Pony Express", :price => "$25.95"]})
+    end
+
+    it "returns a list of shipping rates for the Order" do
+      expect(subject).to be_an Array
+    end
+
+    it "returns ShippingRate objects" do
+      expect(subject.first).to be_an Oshpark::ShippingRate
+    end
+  end
+
+end
+
+
+

data/spec/support/http_client.rb

@@ -8,6 +8,7 @@ class FakeClient
     'projects/abcd1234/approve' => { 'project' => {} },
     'orders'                    => { 'orders' => [{}] },
     'orders/abcd1234'           => { 'order' => {} },
+    'shipping_rates'            => { 'shipping_rates' => [{}] },
     'panels'                    => { 'panels' => [{}] },
     'panels/abcd1234'           => { 'panel' => {} },
   }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oshpark
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - James Harton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -228,6 +228,7 @@ files:
 - lib/oshpark/project.rb
 - lib/oshpark/rubymotion.rb
 - lib/oshpark/shipping_rate.rb
+- lib/oshpark/stateful.rb
 - lib/oshpark/token.rb
 - lib/oshpark/upload.rb
 - lib/oshpark/user.rb
@@ -242,6 +243,7 @@ files:
 - spec/lib/oshpark/order_spec.rb
 - spec/lib/oshpark/panel_spec.rb
 - spec/lib/oshpark/project_spec.rb
+- spec/lib/oshpark/shipping_rate_spec.rb
 - spec/lib/oshpark/upload_spec.rb
 - spec/spec_helper.rb
 - spec/support/http_client.rb
@@ -279,6 +281,7 @@ test_files:
 - spec/lib/oshpark/order_spec.rb
 - spec/lib/oshpark/panel_spec.rb
 - spec/lib/oshpark/project_spec.rb
+- spec/lib/oshpark/shipping_rate_spec.rb
 - spec/lib/oshpark/upload_spec.rb
 - spec/spec_helper.rb
 - spec/support/http_client.rb