smartsend-ruby 0.1.1 → 0.2.0

data/lib/smartsend.rb

@@ -1,11 +1,6 @@
 module Smartsend
 
-  @@api_key = nil
-  @@email = nil
-  @@license = nil
-  @@cms_system = nil
-  @@cms_version = nil
-  @@test_mode = false
+  @@api_token = nil
 
   def self.configure(args={})
     args.each do |k, v|
@@ -14,62 +9,36 @@ module Smartsend
   end
 
   def self.account
-    Smartsend::Account.new(email: @@email, license: @@license)
+    Smartsend::Account.new(api_token: @@api_token)
   end
 
-  def self.api_key
-    @@api_key
+  def self.api_token
+    @@api_token
   end
 
-  def self.email
-    @@email
-  end
-
-  def self.license
-    @@license
-  end
-
-  def self.cms_system
-    @@cms_system
-  end
-
-  def self.cms_version
-    @@cms_version
-  end
-
-  def self.app_version
-    Smartsend::VERSION
-  end
-
-  def self.test_mode
-    @@test_mode
-  end
-
-  def self.test?
-    test_mode
+  class MissingConfigError < StandardError
   end
 
-
-  class TooManyOrdersError < StandardError
+  class AuthorizationError < StandardError
   end
 
-  class MissingConfigError < StandardError
+  class UnknownError < StandardError
   end
 
-  class AuthorizationError < StandardError
+  class NotFoundError < StandardError
   end
 
 end
 
-require_relative 'smartsend/order'
-require_relative 'smartsend/orders'
+require_relative 'smartsend/shipment'
 require_relative 'smartsend/address'
 require_relative 'smartsend/receiver'
 require_relative 'smartsend/sender'
 require_relative 'smartsend/agent'
-require_relative 'smartsend/service'
+require_relative 'smartsend/services'
 require_relative 'smartsend/parcel'
 require_relative 'smartsend/parcel_item'
 require_relative 'smartsend/client'
 require_relative 'smartsend/account'
 require_relative 'smartsend/version'
+require_relative 'smartsend/request_error'

data/test/test_shipment.rb

@@ -0,0 +1,199 @@
+require 'minitest/autorun'
+require 'smartsend'
+require 'date'
+
+class ShipmentTest < Minitest::Test
+
+  def test_successful_label
+    Smartsend.configure(
+      api_token: 'test_token',
+    )
+
+    shipment = Smartsend::Shipment.new(
+      internal_id: "123123123", # your internal order id
+      internal_reference: "AC12345789", # your order number
+      shipping_carrier: "postnord", # postnord/gls/bring/dao
+      shipping_method: "agent",
+      shipping_date: Date.today.strftime('%Y-%m-%d'),
+      currency: "DKK"
+    )
+
+    shipment.services = Smartsend::Services.new(
+      email_notification: 'contact@smartsend.io'
+    )
+
+    # set the receiver of the shipment
+    shipment.receiver = Smartsend::Receiver.new(
+      internal_id: "123456", # your internal customer id
+      internal_reference: "123456",
+      company: "Smart Send",
+      name_line1: "Henrik Hansen",
+      name_line2: "C/O Vivian Hansen",
+      address_line1: "Willemoesgade 42",
+      address_line2: "3.th.",
+      postal_code: "2100",
+      city: "Copenhagen",
+      country: "DK",
+      sms: "12345678",
+      email: "contact@smartsend.io"
+    )
+
+    # optionally set the sender of the shipment
+    shipment.sender = Smartsend::Sender.new(
+      internal_id: "123456",
+      internal_reference: "123456",
+      company: "Smart Send",
+      name_line1: "Henrik Hansen",
+      name_line2: "C/O Vivian Hansen",
+      address_line1: "Willemoesgade 42",
+      address_line2: "3.th.",
+      postal_code: "2100",
+      city: "Copenhagen",
+      country: "DK",
+      sms: "12345678",
+      email: "contact@smartsend.io"
+    )
+
+    # # optionally ship to a droppoint by setting an agent
+    # shipment.agent = Smartsend::Agent.new(
+    #   internal_id: "123456",
+    #   internal_reference: "123457",
+    #   agent_no: "2103", # droppoint id
+    #   company: "Smart Send",
+    #   name_line1: "Henrik Hansen",
+    #   name_line2: "C/O Vivian Hansen",
+    #   address_line1: "Willemoesgade 42",
+    #   address_line2: "3.th.",
+    #   postal_code: "2100",
+    #   city: "Copenhagen",
+    #   country: "DK"
+    # )
+
+    # add one or more parcels/fulfillments to the shipment
+    parcel = Smartsend::Parcel.new(
+      internal_id: "123456789", # your internal parcel id
+      internal_reference: "123456789",
+      weight: 1.25,
+      height: 21,
+      width: 27,
+      length: 35,
+      freetext1: "Brians birthday gift",
+      freetext2: "Don't open this before your birthday Brian",
+      freetext3: "We look forward to seeing you soon Brian",
+    )
+
+    # add items to the parcel
+    parcel_item = Smartsend::ParcelItem.new(
+      internal_id: "ABC123",
+      internal_reference: "ABC123",
+      sku: "ABC123",
+      name: "Product name",
+      quantity: 2,
+      unit_weight: 1.25
+    )
+
+    parcel.items << parcel_item
+    shipment.parcels << parcel
+
+    # send the shipment to Smartsend.io
+    shipment.save!
+
+    assert shipment.success?
+    assert shipment.label_url
+  end
+
+  def test_invalid_request
+    Smartsend.configure(
+      api_token: 'test_token',
+    )
+
+    shipment = Smartsend::Shipment.new(
+      internal_id: "123123123", # your internal order id
+      internal_reference: "AC12345789", # your order number
+      # shipping_carrier: "postnord", # postnord/gls/bring/dao
+      # shipping_method: "agent",
+      shipping_date: Date.today.strftime('%Y-%m-%d'),
+      currency: 'invalid'
+    )
+
+    # set the receiver of the shipment
+    shipment.receiver = Smartsend::Receiver.new(
+      internal_id: "123456", # your internal customer id
+      internal_reference: "123456",
+      company: "Smart Send",
+      name_line1: "Henrik Hansen",
+      name_line2: "C/O Vivian Hansen",
+      address_line1: "Willemoesgade 42",
+      address_line2: "3.th.",
+      postal_code: "2100",
+      city: "Copenhagen",
+      country: "invalid",
+      sms: "12345678",
+      email: "contact@smartsend.io"
+    )
+
+    # optionally set the sender of the shipment
+    shipment.sender = Smartsend::Sender.new(
+      internal_id: "123456",
+      internal_reference: "123456",
+      company: "Smart Send",
+      name_line1: "Henrik Hansen",
+      name_line2: "C/O Vivian Hansen",
+      address_line1: "Willemoesgade 42",
+      address_line2: "3.th.",
+      postal_code: "2100",
+      city: "Copenhagen",
+      country: "DK",
+      sms: "12345678",
+      email: "contact@smartsend.io"
+    )
+
+    # optionally ship to a droppoint by setting an agent
+    shipment.agent = Smartsend::Agent.new(
+      internal_id: "123456",
+      internal_reference: "123457",
+      agent_no: "2103", # droppoint id
+      company: "Smart Send",
+      name_line1: "Henrik Hansen",
+      name_line2: "C/O Vivian Hansen",
+      address_line1: "Willemoesgade 42",
+      address_line2: "3.th.",
+      postal_code: "2100",
+      city: "Copenhagen",
+      country: "invalid"
+    )
+
+    # add one or more parcels/fulfillments to the shipment
+    parcel = Smartsend::Parcel.new(
+      internal_id: "123456789", # your internal parcel id
+      internal_reference: "123456789",
+      weight: 1.25,
+      height: 21,
+      width: 27,
+      length: 35,
+      freetext1: "Brians birthday gift",
+      freetext2: "Don't open this before your birthday Brian",
+      freetext3: "We look forward to seeing you soon Brian",
+    )
+
+    # add items to the parcel
+    parcel_item = Smartsend::ParcelItem.new(
+      internal_id: "ABC123",
+      internal_reference: "ABC123",
+      sku: "ABC123",
+      name: "Product name",
+      quantity: 2,
+      unit_weight: 1.25
+    )
+
+    parcel.items << parcel_item
+    shipment.parcels << parcel
+
+    # send the shipment to Smartsend.io
+    shipment.save!
+
+    assert !shipment.success?
+    assert_equal 5, shipment.error.errors.count
+  end
+
+end

data/test/test_smartsend.rb

@@ -5,14 +5,10 @@ class SmartsendTest < Minitest::Test
 
   def test_configuration
     Smartsend.configure(
-      api_key: 'test_key',
-      email: 'test@test.com',
-      license: 'test_license'
+      api_token: 'test_token',
     )
 
-    assert_equal Smartsend.api_key, 'test_key'
-    assert_equal Smartsend.email, 'test@test.com'
-    assert_equal Smartsend.license, 'test_license'
+    assert_equal Smartsend.api_token, 'test_token'
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smartsend-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Aske Hansen
@@ -42,21 +42,16 @@ files:
 - lib/smartsend/address.rb
 - lib/smartsend/agent.rb
 - lib/smartsend/client.rb
-- lib/smartsend/order.rb
-- lib/smartsend/orders.rb
 - lib/smartsend/parcel.rb
 - lib/smartsend/parcel_item.rb
 - lib/smartsend/receiver.rb
+- lib/smartsend/request_error.rb
 - lib/smartsend/sender.rb
-- lib/smartsend/service.rb
+- lib/smartsend/services.rb
+- lib/smartsend/shipment.rb
 - lib/smartsend/version.rb
 - smartsend-ruby.gemspec
-- test/test_addresses.rb
-- test/test_client.rb
-- test/test_orders.rb
-- test/test_parcel_items.rb
-- test/test_parcels.rb
-- test/test_service.rb
+- test/test_shipment.rb
 - test/test_smartsend.rb
 homepage: https://github.com/smartsendio/smartsend-ruby
 licenses:
@@ -78,15 +73,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Smartsend.io api client
 test_files:
-- test/test_addresses.rb
-- test/test_client.rb
-- test/test_orders.rb
-- test/test_parcel_items.rb
-- test/test_parcels.rb
-- test/test_service.rb
+- test/test_shipment.rb
 - test/test_smartsend.rb

data/lib/smartsend/order.rb

@@ -1,62 +0,0 @@
-class Smartsend::Order
-  attr_accessor :id, :label_url, :order_number, :carrier, :method, :return, :total_price, :shipping_price, :currency,
-    :sender, :receiver, :agent, :parcels, :sms_notification, :email_notification
-
-  def initialize(args={})
-    args.each do |k, v|
-      instance_variable_set "@#{k}", v
-    end
-
-    @parcels ||= []
-  end
-
-  def save!(account: nil)
-    response = Smartsend::Client.new(account).post('booking/order', self.serialize)
-
-    if response.success?
-      update_label_url_tracking_codes(response)
-      self
-    else
-      response
-    end
-  end
-
-  def update_label_url_tracking_codes(response)
-    @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
-        parcel.tracking_code = parcel_response['tracecode']
-        parcel.tracking_url = parcel_response['tracelink']
-      end
-    end
-  end
-
-
-  def serialize
-    {
-      orderno: @order_number,
-      reference: @id,
-      carrier: @carrier,
-      method: @method,
-      return: @return,
-      totalprice: @total_price,
-      shipprice: @shipping_price,
-      currency: @currency,
-      test: false,
-      type: 'pdf',
-      sender: @sender&.serialize,
-      receiver: @receiver&.serialize,
-      agent: @agent&.serialize,
-      parcels: @parcels.map(&:serialize),
-      service: service.serialize
-    }
-  end
-
-  private
-
-  def service
-    Smartsend::Service.new(phone: @sms_notification, email: @email_notification)
-  end
-
-end

data/lib/smartsend/orders.rb

@@ -1,43 +0,0 @@
-class Smartsend::Orders
-  include Enumerable
-  attr_accessor :labels_url
-
-  def initialize(*orders)
-    @orders = orders
-  end
-
-  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(account).post('booking/orders', self.serialize)
-
-    update_label_url_tracking_codes(response)
-
-    self
-  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.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
-
-  def each(&block)
-    @orders.each do |order|
-      block.call(order)
-    end
-  end
-
-end

data/lib/smartsend/service.rb

@@ -1,17 +0,0 @@
-class Smartsend::Service
-  attr_accessor :email, :phone
-
-  def initialize(args={})
-    args.each do |k, v|
-      instance_variable_set "@#{k}", v
-    end
-  end
-
-  def serialize
-    {
-      "notemail": @email,
-      "notesms": @phone
-    }
-  end
-
-end

data/test/test_addresses.rb

@@ -1,80 +0,0 @@
-require 'minitest/autorun'
-require 'smartsend'
-
-class AddressesTest < Minitest::Test
-
-  def test_sender_serializing
-    sender = Smartsend::Sender.new(address)
-
-    assert_equal({
-      "senderid": 1,
-      "company": "Smart Send",
-      "name1": "Henrik Hansen",
-      "name2": "C/O Vivian Hansen",
-      "address1": "Willemoesgade 42",
-      "address2": "3.th.",
-      "zip": 2100,
-      "city": "Copenhagen",
-      "country": "DK",
-      "sms": 12345678,
-      "mail": "contact@smartsend.io"
-    }, sender.serialize)
-  end
-
-  def test_reciver_serializing
-    receiver = Smartsend::Receiver.new(address)
-
-    assert_equal({
-      "receiverid": 1,
-      "company": "Smart Send",
-      "name1": "Henrik Hansen",
-      "name2": "C/O Vivian Hansen",
-      "address1": "Willemoesgade 42",
-      "address2": "3.th.",
-      "zip": 2100,
-      "city": "Copenhagen",
-      "country": "DK",
-      "sms": 12345678,
-      "mail": "contact@smartsend.io"
-    }, receiver.serialize)
-  end
-
-  def test_agent_serializing
-    receiver = Smartsend::Agent.new(address.merge(type: 'PDK'))
-
-    assert_equal({
-      "id": 1,
-      "agentno": 1,
-      "agenttype": "PDK",
-      "company": "Smart Send",
-      "name1": "Henrik Hansen",
-      "name2": "C/O Vivian Hansen",
-      "address1": "Willemoesgade 42",
-      "address2": "3.th.",
-      "zip": 2100,
-      "city": "Copenhagen",
-      "country": "DK",
-      "sms": 12345678,
-      "mail": "contact@smartsend.io"
-    }, receiver.serialize)
-  end
-
-  private
-
-  def address
-    {
-      :id       => 1,
-      :company  => "Smart Send",
-      :name1    => "Henrik Hansen",
-      :name2    => "C/O Vivian Hansen",
-      :address1 => "Willemoesgade 42",
-      :address2 => "3.th.",
-      :zip      => 2100,
-      :city     => "Copenhagen",
-      :country  => "DK",
-      :phone    => 12345678,
-      :mail     => "contact@smartsend.io"
-    }
-  end
-
-end

data/test/test_client.rb

@@ -1,9 +0,0 @@
-require 'minitest/autorun'
-require 'smartsend'
-
-class ClientTest < Minitest::Test
-
-  def test_headers
-  end
-
-end

data/test/test_orders.rb

@@ -1,64 +0,0 @@
-require 'minitest/autorun'
-require 'smartsend'
-
-class OrdersTest < Minitest::Test
-
-  def test_serializing
-    assert_equal(params, order.serialize)
-  end
-
-  def test_collection_serializing
-    orders = Smartsend::Orders.new(order, order)
-
-    assert_equal 2, orders.count
-    assert_equal [params, params], orders.serialize
-  end
-
-  def test_too_many_orders_errors
-    assert_raises Smartsend::TooManyOrdersError do
-      Smartsend::Orders.new(*(0..10).to_a).save_all!
-    end
-  end
-
-  private
-
-  def params
-    {
-      orderno: 'AC12345789',
-      reference: '1234567',
-      carrier: 'postdanmark',
-      method: 'private',
-      return: false,
-      totalprice: 199.75,
-      shipprice: 49,
-      currency: 'DKK',
-      test: false,
-      type: 'pdf',
-      sender: nil,
-      receiver: nil,
-      agent: nil,
-      parcels: [],
-      service: { :notemail=>"contact@smartsend.io", :notesms=>"12345678" }
-    }
-  end
-
-  def order
-    Smartsend::Order.new(
-      :id           => "1234567",
-      :order_number => "AC12345789",
-      :carrier      => "postdanmark",
-      :method       => "private",
-      :return       => false,
-      :total_price   => 199.75,
-      :shipping_price    => 49,
-      :currency     => "DKK",
-      :sms_notification => '12345678',
-      :email_notification => 'contact@smartsend.io',
-      sender: nil,
-      receiver: nil,
-      agent: nil,
-      parcels: []
-    )
-  end
-
-end

data/test/test_parcel_items.rb

@@ -1,26 +0,0 @@
-require 'minitest/autorun'
-require 'smartsend'
-
-class ParcelItemsTest < Minitest::Test
-
-  def test_serializing
-    parcel_item = Smartsend::ParcelItem.new(
-      sku: 'ABC123',
-      title: 'ABC123',
-      quantity: 2,
-      unit_weight: 1.25,
-      unit_price: 144.5,
-      currency: 'DKK'
-    )
-
-    assert_equal({
-      "sku": "ABC123",
-      "title": "ABC123",
-      "quantity": 2,
-      "unitweight": 1.25,
-      "unitprice": 144.5,
-      "currency": "DKK"
-    }, parcel_item.serialize)
-  end
-
-end