smartsend-ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31f5d50cd758e048368ed4208cb76d4bf015b24d
-  data.tar.gz: 521b79b970af201b0def8cadc432b50ca4d592b4
+  metadata.gz: 1daea641d267754bf37d492b13ece1a513f6225e
+  data.tar.gz: 201cf9674744dbd1eb80118e310485814dbcc308
 SHA512:
-  metadata.gz: 304eeeca29e60ff755246261364455fbeb90fe15f8b8943a6cbb9125fff69d2fd908df91f80a68c84f786f8fedcec9e34dfb8ed504a07071918782afa9e14360
-  data.tar.gz: 65a5658a830cb9fd620baa76513a9d7994fd41abe9361665d537175db877d9872263972ffb6f61a11d716613e3ba7ec3bbe025393fc0c3f2b32d4991ca196148
+  metadata.gz: 97a78073a953cee9b2b2719dbaaa91dff9dbc42a6c5a0c19a4dec070bc22f58cca68766ba8ec39414849fe207b4a6854e67223b84a156fe7aba5aac856c2637c
+  data.tar.gz: a075eb79b103e433468a56d7db5bd6040ea5f47b0f1f023c1086367c2c5568e053d70957fb9e096bcdbef5587c86ae2dcd011aa51b4911867e1905c3705d95bf

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Aske Behrsin Hansen
+
+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

@@ -10,9 +10,8 @@ Before beginning you need a Smartsend account.
 gem install 'smartsend-ruby'
 ```
 
-## Usage
 
-### Configuring the client
+## Configuration
 
 ```ruby
 Smartsend.configure(
@@ -24,16 +23,18 @@ Smartsend.configure(
 )
 ```
 
+## Usage
+
 ### Creating an order
 
 This creates a label.
 
 ```ruby
-
 # initalize a new order
 order = Smartsend::Order.new(
+  id: "123123123", # your internal order id
   order_number: "AC12345789",
-  carrier: "postdanmark", # postdanmark/gls/bring
+  carrier: "postnord", # postnord/gls/bring
   method: "private",
   return: false,
   total_price: 199.75,
@@ -58,8 +59,9 @@ order.receiver = Smartsend::Receiver.new(
   mail: "contact@smartsend.io"
 )
 
-# set the receiver of the order
+# optionally set the sender of the order
 order.sender = Smartsend::Sender.new(
+  id: "123456",
   company: "Smart Send",
   name1: "Henrik Hansen",
   name2: "C/O Vivian Hansen",
@@ -72,9 +74,9 @@ order.sender = Smartsend::Sender.new(
   mail: "contact@smartsend.io"
 )
 
-# you can ship to a droppoint by seting an agent
+# optionally ship to a droppoint by setting an agent
 order.agent = Smartsend::Agent.new(
-  id: "7224", # droppoint id
+  id: "2103", # droppoint id
   type: "PDK", # droppoint provider
   company: "Smart Send",
   name1: "Henrik Hansen",
@@ -114,39 +116,59 @@ parcel_item = Smartsend::ParcelItem.new(
   currency: "DKK"
 )
 
-parcel.items = [parcel_item]
-order.parcels = [parcel]
+parcel.items << parcel_item
+order.parcels << parcel
 
 # send the order to Smartsend.io
 order.save!
 ```
 
-After saving an order it is updated with a url for the label pdf and tracking codes for each parcel.
+After saving, the order it is updated with a url for the label pdf and tracking codes for each parcel.
 
 ```ruby
 order.label_url
-  => 'https://www.pacsoftonline.com/...'
+  => 'http://v70.api.smartsend.dk/...'
 
 order.parcels.first.tracking_code
   => '1234...'
 
 order.parcels.first.tracking_url
-  => 'https://...'
+  => 'https://tracking.postnord.com/...'
 ```
 
 ### Creating orders in batch
 
 You can create up to 10 orders in batch.
 
+This updates all orders with a label_url and also gives you a labels_url with the combined labels
+
 ```ruby
-order1 = Smartsend::Order.new(...)
-order2 = Smartsend::Order.new(...)
 
-orders = Smartsend::Orders.new(order1, order2)
+orders = Smartsend::Orders.new
+orders << Smartsend::Order.new(...)
+orders << Smartsend::Order.new(...)
 
 # send the orders to Smartsend.io
 orders.save_all!
 
+orders.labels_url
+  => 'http://v70.api.smartsend.dk/...'
+
 orders.first.label_url
-  => 'https://www.pacsoftonline.com/...'
+  => 'http://v70.api.smartsend.dk/...'
+```
+
+### Using multiple accounts
+
+If your system requires multiple accounts you can pass an account instance when saving orders.
+
+```ruby
+order = Smartsend::Order.new(...)
+
+account = Smartsend::Account.new(
+  email: 'smartsend-username',
+  license: 'smartsend-license-key'
+)
+
+order.save!(account: account)
 ```

data/lib/smartsend/account.rb

@@ -0,0 +1,9 @@
+class Smartsend::Account
+  attr_accessor :email, :license
+
+  def initialize(email:, license:)
+    @email = email
+    @license = license
+  end
+
+end

data/lib/smartsend/client.rb

@@ -4,6 +4,10 @@ class Smartsend::Client
 
   BASE_URL = 'http://smartsend-prod.apigee.net/v7/booking'.freeze
 
+  def initialize(account=nil)
+    @account = account || Smartsend.account
+  end
+
   def post(path, params)
     request do
       http.post("#{BASE_URL}/#{path}", json: params)
@@ -15,8 +19,11 @@ class Smartsend::Client
 
     Rails.logger.debug(response.to_s) if defined?(Rails)
 
-    if /^2/ === response.code.to_s
+    case response.code.to_s
+    when '200'
       Response.new(JSON.parse(response)).successful!
+    when '401'
+      raise Smartsend::AuthorizationError, 'Unable to authorize'
     else
       Response.new(response).failed!
     end
@@ -48,13 +55,13 @@ class Smartsend::Client
 
   def http
     raise Smartsend::MissingConfigError, 'Missing api_key' if Smartsend.api_key.nil?
-    raise Smartsend::MissingConfigError, 'Missing email' if Smartsend.email.nil?
-    raise Smartsend::MissingConfigError, 'Missing license' if Smartsend.license.nil?
+    raise Smartsend::MissingConfigError, 'Missing email'   if @account.email.nil?
+    raise Smartsend::MissingConfigError, 'Missing license' if @account.license.nil?
 
     HTTP.headers(
       apikey: Smartsend.api_key,
-      smartsendmail: Smartsend.email,
-      smartsendlicence: Smartsend.license,
+      smartsendmail: @account.email,
+      smartsendlicence: @account.license,
       cmssystem: Smartsend.cms_system,
       cmsversion: Smartsend.cms_version,
       appversion: Smartsend.app_version,

data/lib/smartsend/order.rb

@@ -6,10 +6,12 @@ class Smartsend::Order
     args.each do |k, v|
       instance_variable_set "@#{k}", v
     end
+
+    @parcels ||= []
   end
 
-  def save!
-    response = Smartsend::Client.new.post('order', self.serialize)
+  def save!(account: nil)
+    response = Smartsend::Client.new(account).post('order', self.serialize)
 
     if response.success?
       update_label_url_tracking_codes(response)
@@ -20,8 +22,7 @@ class Smartsend::Order
   end
 
   def update_label_url_tracking_codes(response)
-    @id = response['id']
-    @label_url = response['link']
+    @label_url = response['pdflink']
 
     response['parcels'].each do |parcel_response|
       if parcel = @parcels.select { |x| x.reference.to_s == parcel_response['reference'].to_s }.first
@@ -35,6 +36,7 @@ class Smartsend::Order
   def serialize
     {
       orderno: @order_number,
+      reference: @id,
       carrier: @carrier,
       method: @method,
       return: @return,
@@ -46,7 +48,7 @@ class Smartsend::Order
       sender: @sender&.serialize,
       receiver: @receiver&.serialize,
       agent: @agent&.serialize,
-      parcels: @parcels.to_a.map(&:serialize),
+      parcels: @parcels.map(&:serialize),
       service: service.serialize
     }
   end

data/lib/smartsend/orders.rb

@@ -1,14 +1,15 @@
 class Smartsend::Orders
   include Enumerable
+  attr_accessor :labels_url
 
   def initialize(*orders)
     @orders = orders
   end
 
-  def save_all!
+  def save_all!(account: nil)
     raise Smartsend::TooManyOrdersError, "You can save a maximum of 10 orders in batch" if count > 10
 
-    response = Smartsend::Client.new.post('orders', self.serialize)
+    response = Smartsend::Client.new(account).post('orders', self.serialize)
 
     update_label_url_tracking_codes(response)
 
@@ -16,13 +17,19 @@ class Smartsend::Orders
   end
 
   def update_label_url_tracking_codes(response)
+    @labels_url = response['combine_pdf']
+    
     response['orders'].each do |response_order|
-      if order = @orders.select { |x| x.order_number.to_s == response.orderno.to_s }.first
-        order.update_label_url_tracking_codes(response)
+      if order = @orders.select { |x| x.id.to_s == response_order['reference'].to_s }.first
+        order.update_label_url_tracking_codes(response_order)
       end
     end
   end
 
+  def <<(order)
+    @orders << order
+  end
+
   def serialize
     @orders.map(&:serialize)
   end

data/lib/smartsend/parcel.rb

@@ -5,6 +5,8 @@ class Smartsend::Parcel
     args.each do |k, v|
       instance_variable_set "@#{k}", v
     end
+
+    @items ||= []
   end
 
   def serialize
@@ -16,7 +18,7 @@ class Smartsend::Parcel
       :width     => @width,
       :length    => @length,
       :size      => @size,
-      :items     => @items.to_a.map(&:serialize)
+      :items     => @items.map(&:serialize)
     }
 
     freetext_lines.to_a.each_with_index do |line, i|

data/lib/smartsend/receiver.rb

@@ -1,5 +1,5 @@
 class Smartsend::Receiver < Smartsend::Address
   def serialize
-    super.merge(reciverid: @id)
+    super.merge(receiverid: @id)
   end
 end

data/lib/smartsend/sender.rb

@@ -1,5 +1,5 @@
 class Smartsend::Sender < Smartsend::Address
   def serialize
-    super.merge(senderid: nil)
+    super.merge(senderid: @id)
   end
 end

data/lib/smartsend/service.rb

@@ -10,13 +10,7 @@ class Smartsend::Service
   def serialize
     {
       "notemail": @email,
-      "notesms": @phone,
-      "prenote": true,
-      "prenote_from": "contact@smartsend.io",
-      "prenote_to": "contact@smartsend.io",
-      "prenote_message": "Your order is now on the way.",
-      "flex": "string",
-      "waybillid": "string"
+      "notesms": @phone
     }
   end
 

data/lib/smartsend/version.rb

@@ -1,3 +1,3 @@
 module Smartsend
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/smartsend.rb

@@ -13,6 +13,10 @@ module Smartsend
     end
   end
 
+  def self.account
+    Smartsend::Account.new(email: @@email, license: @@license)
+  end
+
   def self.api_key
     @@api_key
   end
@@ -52,16 +56,20 @@ module Smartsend
   class MissingConfigError < StandardError
   end
 
+  class AuthorizationError < StandardError
+  end
 
 end
 
-require 'smartsend/order'
-require 'smartsend/orders'
-require 'smartsend/address'
-require 'smartsend/receiver'
-require 'smartsend/sender'
-require 'smartsend/agent'
-require 'smartsend/service'
-require 'smartsend/parcel'
-require 'smartsend/parcel_item'
-require 'smartsend/client'
+require_relative 'smartsend/order'
+require_relative 'smartsend/orders'
+require_relative 'smartsend/address'
+require_relative 'smartsend/receiver'
+require_relative 'smartsend/sender'
+require_relative 'smartsend/agent'
+require_relative 'smartsend/service'
+require_relative 'smartsend/parcel'
+require_relative 'smartsend/parcel_item'
+require_relative 'smartsend/client'
+require_relative 'smartsend/account'
+require_relative 'smartsend/version'

data/smartsend-ruby.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |s|
   s.version     = Smartsend::VERSION
   s.date        = '2017-11-13'
   s.summary     = "Smartsend.io api client"
-  s.description = "Create orders in smartsend for smartsend"
+  s.description = "Create orders in smartsend"
   s.authors     = ["Aske Hansen"]
   s.email       = 'aske@deeco.dk'
-  s.homepage    = 'https://github.com/askehansen/smartsend-ruby'
+  s.homepage    = 'https://github.com/smartsendio/smartsend-ruby'
   s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")

data/test/test_addresses.rb

@@ -7,7 +7,7 @@ class AddressesTest < Minitest::Test
     sender = Smartsend::Sender.new(address)
 
     assert_equal({
-      "senderid": nil,
+      "senderid": 1,
       "company": "Smart Send",
       "name1": "Henrik Hansen",
       "name2": "C/O Vivian Hansen",
@@ -25,7 +25,7 @@ class AddressesTest < Minitest::Test
     receiver = Smartsend::Receiver.new(address)
 
     assert_equal({
-      "reciverid": 1,
+      "receiverid": 1,
       "company": "Smart Send",
       "name1": "Henrik Hansen",
       "name2": "C/O Vivian Hansen",

data/test/test_orders.rb

@@ -25,6 +25,7 @@ class OrdersTest < Minitest::Test
   def params
     {
       orderno: 'AC12345789',
+      reference: '1234567',
       carrier: 'postdanmark',
       method: 'private',
       return: false,
@@ -37,12 +38,13 @@ class OrdersTest < Minitest::Test
       receiver: nil,
       agent: nil,
       parcels: [],
-      service: {:notemail=>"contact@smartsend.io", :notesms=>"12345678", :prenote=>true, :prenote_from=>"contact@smartsend.io", :prenote_to=>"contact@smartsend.io", :prenote_message=>"Your order is now on the way.", :flex=>"string", :waybillid=>"string"}
+      service: { :notemail=>"contact@smartsend.io", :notesms=>"12345678" }
     }
   end
 
   def order
     Smartsend::Order.new(
+      :id           => "1234567",
       :order_number => "AC12345789",
       :carrier      => "postdanmark",
       :method       => "private",

data/test/test_service.rb

@@ -8,13 +8,7 @@ class SerivceTest < Minitest::Test
 
     assert_equal({
     "notemail": "contact@smartsend.io",
-    "notesms": "12345678",
-    "prenote": true,
-    "prenote_from": "contact@smartsend.io",
-    "prenote_to": "contact@smartsend.io",
-    "prenote_message": "Your order is now on the way.",
-    "flex": "string",
-    "waybillid": "string"
+    "notesms": "12345678"
   }, service.serialize)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartsend-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Aske Hansen
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-description: Create orders in smartsend for smartsend
+description: Create orders in smartsend
 email: aske@deeco.dk
 executables: []
 extensions: []
@@ -33,10 +33,12 @@ files:
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
+- MIT-LICENSE
 - README.md
 - Rakefile
 - lib/smartsend-ruby.rb
 - lib/smartsend.rb
+- lib/smartsend/account.rb
 - lib/smartsend/address.rb
 - lib/smartsend/agent.rb
 - lib/smartsend/client.rb
@@ -56,7 +58,7 @@ files:
 - test/test_parcels.rb
 - test/test_service.rb
 - test/test_smartsend.rb
-homepage: https://github.com/askehansen/smartsend-ruby
+homepage: https://github.com/smartsendio/smartsend-ruby
 licenses:
 - MIT
 metadata: {}