pwinty 3.0.5 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed7db0843764844edfd7aa88b2c2bcfd9ea3445363cce5ac04a099f0db05478a
-  data.tar.gz: 0c8dfce677943320fa92a672a739c5ec05ae323357af47bcc3856426e44b06c1
+  metadata.gz: 290864d8b0b05f062c739b0ad74a6d5e4fb722a685343e20d3608529589d1d71
+  data.tar.gz: 825267f3abe3d13417380b5203aef156e2bc303f39d668859ff05af2259bfc9c
 SHA512:
-  metadata.gz: dea713ec0c5667fa2578f9c82d8654f8b0bd25e2240715cc630db018414a3398f3744a7278c6b373363d74a2eae72e6b27a049904110aef013095d2c636475ea
-  data.tar.gz: b816f723de43d8ac43d03077ad6d6ca1002d95ba12808caae6291fde1215ff9c3b57256a09ab0c890f8f7a95f22a869e1d9c1ee32706b40a93ee624ffc127287
+  metadata.gz: 80d135300d8909a8676268a20de3d1febdaa3099008df4bed4a83440ffe03c23e584da706cbe79769736570411a8c21c0fbebb96427e1548ae5f6e3f0eef0801
+  data.tar.gz: 1e45b1a0072531eda9c95b77e7ca300a8fe4e9dc436f78220894072cbe15c70ad88da2ada678f356d789fe6e37440e35ba02fbb30dfa05a951be5139eda9309e

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  DisabledByDefault: true
+Layout/IndentationStyle:
+  Enabled: true
+Layout/IndentationWidth:
+  Enabled: true
+Layout/IndentationConsistency:
+  Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pwinty (3.0.5)
+    pwinty (3.0.6)
       dry-struct (~> 1.0)
       dry-struct-setters (~> 0.2)
       faraday (~> 0.15)

data/lib/pwinty.rb

@@ -13,50 +13,50 @@ require "pwinty/shipping_info"
 require "pwinty/version"
 
 module Pwinty
-    class Error < StandardError; end
-    class AuthenticationError < Pwinty::Error; end
-    class OrderNotFound < Pwinty::Error; end
-    class StateIsInvalid < Pwinty::Error; end
-
-    MERCHANT_ID = ENV['PWINTY_MERCHANT_ID']
-    API_KEY     = ENV['PWINTY_API_KEY']
-    BASE_URL    = ENV['PWINTY_BASE_URL'] || 'https://sandbox.pwinty.com'
-    API_VERSION = 'v3.0'
-
-    class << self
-        attr_accessor :logger
-        def logger
-            @logger ||= Logger.new($stdout).tap do |log|
-                log.progname = self.name
-            end
-        end
+  class Error < StandardError; end
+  class AuthenticationError < Pwinty::Error; end
+  class OrderNotFound < Pwinty::Error; end
+  class StateIsInvalid < Pwinty::Error; end
+
+  MERCHANT_ID = ENV['PWINTY_MERCHANT_ID']
+  API_KEY     = ENV['PWINTY_API_KEY']
+  BASE_URL    = ENV['PWINTY_BASE_URL'] || 'https://sandbox.pwinty.com'
+  API_VERSION = 'v3.0'
+
+  class << self
+    attr_accessor :logger
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = self.name
+      end
     end
-
-    def self.url
-        "#{Pwinty::BASE_URL}/#{Pwinty::API_VERSION}/"
-    end
-
-    def self.headers
-        {
-            'X-Pwinty-MerchantId' => Pwinty::MERCHANT_ID,
-            'X-Pwinty-REST-API-Key' => Pwinty::API_KEY,
-        }
-    end
-
-    def self.conn
-        Faraday.new(url: url, headers: headers) do |config|
-            config.request :json
-            config.response :json
-            config.use Pwinty::HttpErrors
-            config.adapter Faraday.default_adapter
-        end
+  end
+
+  def self.url
+    "#{Pwinty::BASE_URL}/#{Pwinty::API_VERSION}/"
+  end
+
+  def self.headers
+    {
+      'X-Pwinty-MerchantId' => Pwinty::MERCHANT_ID,
+      'X-Pwinty-REST-API-Key' => Pwinty::API_KEY,
+    }
+  end
+
+  def self.conn
+    Faraday.new(url: url, headers: headers) do |config|
+      config.request :json
+      config.response :json
+      config.use Pwinty::HttpErrors
+      config.adapter Faraday.default_adapter
     end
+  end
 
-    def self.collate_results(response_data, targetted_class)
-        collection = []
-        response_data.each do |individual_attr|
-            collection << targetted_class.new(individual_attr)
-        end
-        collection
+  def self.collate_results(response_data, targetted_class)
+    collection = []
+    response_data.each do |individual_attr|
+      collection << targetted_class.new(individual_attr)
     end
+    collection
+  end
 end

data/lib/pwinty/base.rb

@@ -2,11 +2,11 @@ require 'dry-struct'
 
 module Pwinty
 
-	module Types
-  		include Dry::Types()
-	end
+  module Types
+    include Dry::Types()
+  end
 
-	class Base < Dry::Struct
-		transform_keys(&:to_sym)
-	end
+  class Base < Dry::Struct
+    transform_keys(&:to_sym)
+  end
 end

data/lib/pwinty/country.rb

@@ -1,12 +1,12 @@
 module Pwinty
 
-	class Country < Pwinty::Base
-		attribute :name, Types::String
-		attribute :isoCode, Types::String
+  class Country < Pwinty::Base
+    attribute :name, Types::String
+    attribute :isoCode, Types::String
 
-		def self.list
-			response = Pwinty.conn.get("countries")
-			Pwinty.collate_results(response.body['data'], self)
-		end
-	end
+    def self.list
+      response = Pwinty.conn.get("countries")
+      Pwinty.collate_results(response.body['data'], self)
+    end
+  end
 end

data/lib/pwinty/http_errors.rb

@@ -1,13 +1,13 @@
 module Pwinty
-	class HttpErrors < Faraday::Response::Middleware
-		def on_complete(env)
-			msg = env[:body]
-			case env[:status]
-			when 401; raise Pwinty::AuthenticationError, msg
-			when 403; raise Pwinty::StateIsInvalid, msg
-			when 404; raise Pwinty::NotFound, msg
-			when 500; raise Pwinty::Error, msg
-			end
-		end
-	end
+  class HttpErrors < Faraday::Response::Middleware
+    def on_complete(env)
+      msg = env[:body]
+      case env[:status]
+      when 401; raise Pwinty::AuthenticationError, msg
+      when 403; raise Pwinty::StateIsInvalid, msg
+      when 404; raise Pwinty::NotFound, msg
+      when 500; raise Pwinty::Error, msg
+      end
+    end
+  end
 end

data/lib/pwinty/image.rb

@@ -1,24 +1,24 @@
 module Pwinty
 
-	class Image < Pwinty::Base
-		attribute :id, Types::Integer
-		attribute :url, Types::String
-		attribute :status, Types::String
-		attribute :copies, Types::Integer
-		attribute :sizing, Types::String
-		attribute :price, Types::Integer
-		attribute :priceToUser, Types::Integer.optional
-		attribute :md5Hash, Types::String.optional
-		attribute :previewUrl, Types::String.optional
-		attribute :thumbnailUrl, Types::String.optional
-		attribute :sku, Types::String
-		attribute :attributes, Types::Hash.schema(
-			substrateWeight?: Types::String.optional,
-			frame?: Types::String.optional,
-			edge?: Types::String.optional,
-			paperType?: Types::String.optional,
-			frameColour?: Types::String.optional,
-		).optional
-		attribute :errorMessage, Types::String.optional
-	end
+  class Image < Pwinty::Base
+    attribute :id, Types::Integer
+    attribute :url, Types::String
+    attribute :status, Types::String
+    attribute :copies, Types::Integer
+    attribute :sizing, Types::String
+    attribute :price, Types::Integer
+    attribute :priceToUser, Types::Integer.optional
+    attribute :md5Hash, Types::String.optional
+    attribute :previewUrl, Types::String.optional
+    attribute :thumbnailUrl, Types::String.optional
+    attribute :sku, Types::String
+    attribute :attributes, Types::Hash.schema(
+      substrateWeight?: Types::String.optional,
+      frame?: Types::String.optional,
+      edge?: Types::String.optional,
+      paperType?: Types::String.optional,
+      frameColour?: Types::String.optional,
+    ).optional
+    attribute :errorMessage, Types::String.optional
+  end
 end

data/lib/pwinty/order.rb

@@ -3,124 +3,132 @@ require 'dry/struct/with_setters'
 require "pwinty/shipping_info"
 
 module Pwinty
-    class Order < Pwinty::Base
-        include Dry::Struct::Setters
-        include Dry::Struct::Setters::MassAssignment
-
-        attribute :id, Types::Integer
-        attribute :address1, Types::String.optional
-        attribute :address2, Types::String.optional
-        attribute :postalOrZipCode, Types::String.optional
-        attribute :countryCode, Types::String
-        attribute :addressTownOrCity, Types::String.optional
-        attribute :recipientName, Types::String.optional
-        attribute :stateOrCounty, Types::String.optional
-        attribute :status, Types::String
-        attribute :payment, Types::String
-        attribute? :packingSlipUrl, Types::String.optional
-        attribute :paymentUrl, Types::String.optional
-        attribute :price, Types::Integer
-        attribute :shippingInfo, Pwinty::ShippingInfo
-        attribute :images, Types::Array.of(Pwinty::Image)
-        attribute :merchantOrderId, Types::String.optional
-        attribute :preferredShippingMethod, Types::String
-        attribute :mobileTelephone, Types::String.optional
-        attribute :created, Types::JSON::DateTime
-        attribute :lastUpdated, Types::JSON::DateTime
-        attribute :canCancel, Types::Bool
-        attribute :canHold, Types::Bool
-        attribute :canUpdateShipping, Types::Bool
-        attribute :canUpdateImages, Types::Bool
-        attribute :errorMessage, Types::String.optional
-        attribute :invoiceAmountNet, Types::Integer
-        attribute :invoiceTax, Types::Integer
-        attribute :invoiceCurrency, Types::String.optional
-        attribute :tag, Types::String.optional
-
-        def self.list(page_size=50)
-            all_orders = list_each_page(page_size)
-            Pwinty.collate_results(all_orders, self)
-        end
-
-        def self.list_each_page(page_size, page_start=0, total_orders_count=nil)
-            all_orders = []
-            while total_orders_count.nil? or all_orders.count < total_orders_count
-                response = Pwinty.conn.get("orders?limit=#{page_size}&start=#{page_start}")
-                total_orders_count ||= response.body['data']['count']
-                all_orders = all_orders + response.body['data']['content']
-                page_start = page_start + page_size
-            end
-            all_orders
-        end
-
-
-        def self.count
-            response = Pwinty.conn.get("orders?count=1&offset=0")
-            response.body['data']['count']
-        end
-
-
-        def self.create(**args)
-            response = Pwinty.conn.post("orders", args)
-            new(response.body['data'])
-        end
-
-        def self.find(id)
-            response = Pwinty.conn.get("orders/#{id}")
-            new(response.body['data'])
-        end
-
-        def update(**args)
-            update_body = self.to_hash.merge(args)
-            response = Pwinty.conn.put("orders/#{self.id}/", update_body)
-            self.assign_attributes(response.body['data'])
-        end
-
-        def submission_status
-            response = Pwinty.conn.get("orders/#{id}/SubmissionStatus")
-            Pwinty::OrderStatus.new(response.body['data'])
-        end
-
-        def submit
-            self.update_status 'Submitted'
-        end
-
-        def cancel
-            self.update_status 'Cancelled'
-        end
-
-        def hold
-            self.update_status 'AwaitingPayment'
-        end
-
-        def add_image image
-            images = add_images([image])
-            self.images
-        end
-
-        def add_images images
-            response = Pwinty.conn.post("orders/#{self.id}/images/batch", images)
-            success = response.status == 200
-            unless success
-                Pwinty.logger.warn response.body['statusTxt']
-            end
-            if response.body['data'] && response.body['data']['items']
-                images = Pwinty.collate_results(response.body['data']['items'], Pwinty::Image)
-                self.images = self.images + images
-            end
-            self.images
-        end
-
-        protected
-
-        def update_status status
-            response = Pwinty.conn.post("orders/#{self.id}/status", {status: status})
-            success = response.status == 200
-            unless success
-                Pwinty.logger.warn response.body['statusTxt']
-            end
-            success
-        end
+  class Order < Pwinty::Base
+    include Dry::Struct::Setters
+    include Dry::Struct::Setters::MassAssignment
+
+    attribute :id, Types::Integer
+    attribute :address1, Types::String.optional
+    attribute :address2, Types::String.optional
+    attribute :postalOrZipCode, Types::String.optional
+    attribute :countryCode, Types::String
+    attribute :addressTownOrCity, Types::String.optional
+    attribute :recipientName, Types::String.optional
+    attribute :stateOrCounty, Types::String.optional
+    attribute :status, Types::String
+    attribute :payment, Types::String
+    attribute? :packingSlipUrl, Types::String.optional
+    attribute :paymentUrl, Types::String.optional
+    attribute :price, Types::Integer
+    attribute :shippingInfo, Pwinty::ShippingInfo
+    attribute :images, Types::Array.of(Pwinty::Image)
+    attribute :merchantOrderId, Types::String.optional
+    attribute :preferredShippingMethod, Types::String
+    attribute :mobileTelephone, Types::String.optional
+    attribute :created, Types::JSON::DateTime
+    attribute :lastUpdated, Types::JSON::DateTime
+    attribute :canCancel, Types::Bool
+    attribute :canHold, Types::Bool
+    attribute :canUpdateShipping, Types::Bool
+    attribute :canUpdateImages, Types::Bool
+    attribute :errorMessage, Types::String.optional
+    attribute :invoiceAmountNet, Types::Integer
+    attribute :invoiceTax, Types::Integer
+    attribute :invoiceCurrency, Types::String.optional
+    attribute :tag, Types::String.optional
+
+    def self.list(page_size=50)
+      all_orders = list_each_page(page_size)
+      Pwinty.collate_results(all_orders, self)
+    end
+
+    def self.list_each_page(page_size, page_start=0, total_orders_count=nil)
+      all_orders = []
+      while total_orders_count.nil? or all_orders.count < total_orders_count
+        response = Pwinty.conn.get("orders?limit=#{page_size}&start=#{page_start}")
+        total_orders_count ||= response.body['data']['count']
+        all_orders = all_orders + response.body['data']['content']
+        page_start = page_start + page_size
+      end
+      all_orders
+    end
+
+
+    def self.count
+      response = Pwinty.conn.get("orders?count=1&offset=0")
+      response.body['data']['count']
+    end
+
+
+    def self.create(**args)
+      response = Pwinty.conn.post("orders", args)
+      new(response.body['data'])
+    end
+
+    def self.find(id)
+      response = Pwinty.conn.get("orders/#{id}")
+      new(response.body['data'])
+    end
+
+    def update(**args)
+      update_body = self.to_hash.merge(args)
+      response = Pwinty.conn.put("orders/#{self.id}/", update_body)
+      update_instance_attributes(response.body['data'])
+    end
+
+    def submission_status
+      response = Pwinty.conn.get("orders/#{id}/SubmissionStatus")
+      Pwinty::OrderStatus.new(response.body['data'])
+    end
 
+    def submit
+      self.update_status 'Submitted'
     end
+
+    def cancel
+      self.update_status 'Cancelled'
+    end
+
+    def hold
+      self.update_status 'AwaitingPayment'
+    end
+
+    def add_image image
+      images = add_images([image])
+      self.images
+    end
+
+    def add_images images
+      response = Pwinty.conn.post("orders/#{self.id}/images/batch", images)
+      success = response.status == 200
+      unless success
+        Pwinty.logger.warn response.body['statusTxt']
+      end
+      if response.body['data'] && response.body['data']['items']
+        images = Pwinty.collate_results(response.body['data']['items'], Pwinty::Image)
+        self.images = self.images + images
+      end
+      self.images
+    end
+
+    def update_instance_attributes(attrs)
+      self.assign_attributes(attrs)
+    end
+
+    def packingSlipUrl=(new_url)
+      @attributes[:packingSlipUrl] = new_url
+    end
+
+    protected
+
+    def update_status status
+      response = Pwinty.conn.post("orders/#{self.id}/status", {status: status})
+      success = response.status == 200
+      unless success
+        Pwinty.logger.warn response.body['statusTxt']
+      end
+      success
+    end
+
+  end
 end

data/lib/pwinty/order_status.rb

@@ -2,16 +2,16 @@ require 'pwinty/photo_status'
 
 module Pwinty
 
-	class OrderStatus < Pwinty::Base
-		attribute :id, Types::Coercible::Integer
-		attribute :isValid, Types::Bool
-		attribute :generalErrors, Types::Array.of(Types::String)
-		attribute :photos, Types::Array.of(Pwinty::PhotoStatus)
-		
+  class OrderStatus < Pwinty::Base
+    attribute :id, Types::Coercible::Integer
+    attribute :isValid, Types::Bool
+    attribute :generalErrors, Types::Array.of(Types::String)
+    attribute :photos, Types::Array.of(Pwinty::PhotoStatus)
+    
 
-		def self.check(id)
-	      	response = Pwinty.conn.get("orders/#{id}/SubmissionStatus")
-	      	new(response.body['data'])
-	    end
-	end
+    def self.check(id)
+      response = Pwinty.conn.get("orders/#{id}/SubmissionStatus")
+      new(response.body['data'])
+    end
+  end
 end

data/lib/pwinty/photo_status.rb

@@ -1,8 +1,8 @@
 module Pwinty
 
-	class PhotoStatus < Pwinty::Base
-		attribute :id, Types::Coercible::Integer
-		attribute :errors, Types::Array.of(Types::String)
-		attribute :warnings, Types::Array.of(Types::String)
-	end
+  class PhotoStatus < Pwinty::Base
+    attribute :id, Types::Coercible::Integer
+    attribute :errors, Types::Array.of(Types::String)
+    attribute :warnings, Types::Array.of(Types::String)
+  end
 end

data/lib/pwinty/shipment.rb

@@ -1,14 +1,14 @@
 module Pwinty
 
-	class Shipment < Pwinty::Base
-		attribute :shipmentId, Types::String.optional
-		attribute :isTracked, Types::Bool
-		attribute :trackingNumber, Types::String.optional
-		attribute :trackingUrl, Types::String.optional
-		attribute :carrier, Types::String.optional
-		attribute :photoIds, Types::Array.of(Types::Integer)
-		attribute :earliestEstimatedArrivalDate, Types::JSON::DateTime
-		attribute :latestEstimatedArrivalDate, Types::JSON::DateTime
-		attribute :shippedOn, Types::JSON::DateTime.optional
-	end
+  class Shipment < Pwinty::Base
+    attribute :shipmentId, Types::String.optional
+    attribute :isTracked, Types::Bool
+    attribute :trackingNumber, Types::String.optional
+    attribute :trackingUrl, Types::String.optional
+    attribute :carrier, Types::String.optional
+    attribute :photoIds, Types::Array.of(Types::Integer)
+    attribute :earliestEstimatedArrivalDate, Types::JSON::DateTime
+    attribute :latestEstimatedArrivalDate, Types::JSON::DateTime
+    attribute :shippedOn, Types::JSON::DateTime.optional
+  end
 end

data/lib/pwinty/shipping_info.rb

@@ -2,8 +2,8 @@ require "pwinty/shipment"
 
 module Pwinty
 
-	class ShippingInfo < Pwinty::Base
-		attribute :price, Types::Integer
-		attribute :shipments, Types::Array.of(Pwinty::Shipment)
-	end
+  class ShippingInfo < Pwinty::Base
+    attribute :price, Types::Integer
+    attribute :shipments, Types::Array.of(Pwinty::Shipment)
+  end
 end

data/lib/pwinty/version.rb

@@ -1,3 +1,3 @@
 module Pwinty
-  VERSION = "3.0.5"
+  VERSION = "3.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwinty
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.0.6
 platform: ruby
 authors:
 - Thomas Harvey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -189,6 +189,7 @@ files:
 - ".env.sample"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -232,7 +233,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Order photo prints through Pwinty