pwinty 3.0.5 → 4.0.0

data/lib/pwinty/api_models/order_charge.rb

@@ -0,0 +1,5 @@
+module Pwinty
+  class OrderCharge < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#order-object-charge"""
+  end
+end

data/lib/pwinty/api_models/order_cost.rb

@@ -0,0 +1,7 @@
+module Pwinty
+  class OrderCost < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#order-object-cost"""
+    attribute? :amount, Types::String.optional
+    attribute? :currency, Types::String.optional
+  end
+end

data/lib/pwinty/api_models/order_item.rb

@@ -0,0 +1,24 @@
+module Pwinty
+  class OrderItem < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#order-object-item"""
+    attribute? :id, Types::String.optional
+    attribute? :merchantReference, Types::String.optional
+    attribute? :sku, Types::String
+    attribute? :copies, Types::Integer
+    attribute? :sizing, Types::String.default('fillPrintArea')
+    attribute? :assets, Types::Array.of(Pwinty::OrderAsset)
+    attribute? :attributes, Types::Hash
+
+    def serializable
+      item_attrs = Hash.new
+      item_attrs.update(self.attributes)
+      item_attrs[:assets] = []
+      for asset in self.assets
+        item_attrs[:assets] << asset.attributes 
+      end
+      item_attrs
+    end
+
+  end
+
+end

data/lib/pwinty/api_models/order_packing_slip.rb

@@ -0,0 +1,7 @@
+module Pwinty
+  class OrderPackingSlip < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#order-object-packing-slip"""
+    attribute? :url, Types::String.optional
+    attribute? :status, Types::String.optional
+  end
+end

data/lib/pwinty/api_models/order_recipient.rb

@@ -0,0 +1,17 @@
+require "pwinty/api_models/order_recipient_address"
+
+module Pwinty
+  class OrderRecipient < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#order-object-recipient"""
+    attribute? :name, Types::String.optional
+    attribute? :email, Types::String.optional
+    attribute? :phoneNumber, Types::String.optional
+    attribute? :address, Pwinty::OrderRecipientAddress
+
+    def serializable
+      recp_attrs = self.attributes
+      recp_attrs[:address] = self.address.attributes
+      recp_attrs
+    end
+  end
+end

data/lib/pwinty/api_models/order_recipient_address.rb

@@ -0,0 +1,11 @@
+module Pwinty
+  class OrderRecipientAddress < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#order-object-address"""
+    attribute? :line1, Types::String.optional
+    attribute? :line2, Types::String.optional
+    attribute? :postalOrZipCode, Types::String.optional
+    attribute? :countryCode, Types::String.optional
+    attribute? :townOrCity, Types::String.optional
+    attribute? :stateOrCounty, Types::String.optional
+  end
+end

data/lib/pwinty/api_models/order_shipment.rb

@@ -0,0 +1,16 @@
+require "pwinty/api_models/order_shipment_carrier"
+require "pwinty/api_models/order_shipment_item"
+require "pwinty/api_models/order_shipment_fulfillment_location"
+require "pwinty/api_models/order_tracking"
+
+module Pwinty
+  class OrderShipment < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#order-object-shipment"""
+    attribute? :id, Types::String.optional
+    attribute? :carrier, Pwinty::OrderShipmentCarrier.optional
+    attribute? :tracking, Pwinty::OrderTracking.optional
+    attribute? :dispatchDate, Types::String.optional
+    attribute? :items, Types::Array.of(Pwinty::OrderShipmentItem).optional
+    attribute? :fulfillmentLocation, Pwinty::OrderShipmentFulfillmentLocation
+  end
+end

data/lib/pwinty/api_models/order_shipment_carrier.rb

@@ -0,0 +1,6 @@
+module Pwinty
+  class OrderShipmentCarrier < Pwinty::Base
+    attribute? :name, Types::String.optional
+    attribute? :service, Types::String.optional
+  end
+end

data/lib/pwinty/api_models/order_shipment_fulfillment_location.rb

@@ -0,0 +1,7 @@
+module Pwinty
+  class OrderShipmentFulfillmentLocation < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#order-object-fulfillment-location"""
+    attribute? :countryCode, Types::String.optional
+    attribute? :labCode, Types::String.optional
+  end
+end

data/lib/pwinty/api_models/order_shipment_item.rb

@@ -0,0 +1,6 @@
+module Pwinty
+  class OrderShipmentItem < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#order-shipment-item"""
+    attribute? :id, Types::String.optional
+  end
+end

data/lib/pwinty/api_models/order_status.rb

@@ -0,0 +1,11 @@
+require "pwinty/api_models/order_status_details"
+require "pwinty/api_models/order_status_issue"
+
+module Pwinty
+  class OrderStatus < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#status-status-object"""
+    attribute? :stage, Types::String.default('NotYetSubmitted')
+    attribute? :details, Pwinty::OrderStatusDetails
+    attribute? :issues, Types::Array.of(Pwinty::OrderStatusIssue)
+  end
+end

data/lib/pwinty/api_models/order_status_auth_details.rb

@@ -0,0 +1,7 @@
+module Pwinty
+  class OrderStatusAuthDetails < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#status-status-authorisation-details"""
+    attribute? :authorisationUrl, Types::String.optional
+    attribute? :paymentDetails, Pwinty::OrderCost
+  end
+end

data/lib/pwinty/api_models/order_status_details.rb

@@ -0,0 +1,10 @@
+module Pwinty
+  class OrderStatusDetails < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#status-status-object-details"""
+    attribute? :downloadAssets, Types::String.optional
+    attribute? :allocateProductionLocation, Types::String.optional
+    attribute? :printReadyAssetsPrepared, Types::String.optional
+    attribute? :inProduction, Types::String.optional
+    attribute? :shipping, Types::String.optional
+  end
+end

data/lib/pwinty/api_models/order_status_issue.rb

@@ -0,0 +1,11 @@
+require "pwinty/api_models/order_status_auth_details"
+
+module Pwinty
+  class OrderStatusIssue < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#status-status-object-issues"""
+    attribute? :objectId, Types::String.optional
+    attribute? :errorCode, Types::String.optional
+    attribute? :description, Types::String.optional
+    attribute? :authorisationDetails, Pwinty::OrderStatusAuthDetails.optional
+  end
+end

data/lib/pwinty/api_models/order_tracking.rb

@@ -0,0 +1,6 @@
+module Pwinty
+  class OrderTracking < Pwinty::Base
+    attribute? :number, Types::String.optional
+    attribute? :url, Types::String.optional
+  end
+end

data/lib/pwinty/api_models/product.rb

@@ -0,0 +1,19 @@
+require "pwinty/api_models/product_dimensions"
+require "pwinty/api_models/product_variant"
+
+module Pwinty
+  class Product < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#product-details"""
+    attribute :sku, Types::String
+    attribute :description, Types::String
+    attribute :productDimensions, Pwinty::ProductDimensions
+    attribute :attributes, Types::Hash
+    attribute :printAreas, Types::Hash
+    attribute :variants, Types::Array.of(Pwinty::ProductVariant)
+
+    def self.find(sku)
+      response = Pwinty.conn.get("products/#{sku}")
+      new(response.body['product'])
+    end
+  end
+end

data/lib/pwinty/api_models/product_dimensions.rb

@@ -0,0 +1,8 @@
+module Pwinty
+  class ProductDimensions < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#product-details-object"""
+    attribute :width, Types::Float
+    attribute :height, Types::Float
+    attribute :units, Types::String
+  end
+end

data/lib/pwinty/api_models/product_variant.rb

@@ -0,0 +1,8 @@
+module Pwinty
+  class ProductVariant < Pwinty::Base
+    """https://www.prodigi.com/print-api/docs/reference/#product-details-object-variant"""
+    attribute :attributes, Types::Hash
+    attribute :shipsTo, Types::Array.of(Types::String)
+    attribute :printAreaSizes, Types::Hash
+  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/http_errors.rb

@@ -1,13 +1,15 @@
 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 400; raise Pwinty::ValidationError, msg
+        when 401; raise Pwinty::AuthenticationError, msg
+        when 404; raise Pwinty::NotFound, msg
+        when 405; raise Pwinty::MethodNotAllowed, msg
+        when 415; raise Pwinty::InvalidContentTypeHeader, msg
+        when 500; raise Pwinty::Error, msg
+      end
+    end
+  end
 end

data/lib/pwinty/version.rb

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

data/lib/pwinty.rb

@@ -2,61 +2,60 @@ require 'faraday'
 require 'faraday_middleware'
 
 require "pwinty/base"
-require "pwinty/country"
 require "pwinty/http_errors"
-require "pwinty/image"
-require "pwinty/order"
-require "pwinty/order_status"
-require 'pwinty/photo_status'
-require "pwinty/shipment"
-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
-    end
-
-    def self.url
-        "#{Pwinty::BASE_URL}/#{Pwinty::API_VERSION}/"
-    end
+require "pwinty/api_models/order"
+require 'pwinty/api_models/product'
 
-    def self.headers
-        {
-            'X-Pwinty-MerchantId' => Pwinty::MERCHANT_ID,
-            'X-Pwinty-REST-API-Key' => Pwinty::API_KEY,
-        }
+module Pwinty
+  class Error < StandardError; end
+  class OrderActionUnavailable < Pwinty::Error; end
+  class AuthenticationError < Pwinty::Error; end
+  class InvalidContentTypeHeader < Pwinty::Error; end
+  class MethodNotAllowed < Pwinty::Error; end
+  class OrderNotFound < Pwinty::Error; end
+  class StateIsInvalid < Pwinty::Error; end
+  class ValidationError < Pwinty::Error; end
+
+  MERCHANT_ID = ENV['PWINTY_MERCHANT_ID']
+  API_KEY     = ENV['PWINTY_API_KEY']
+  BASE_URL    = ENV['PWINTY_BASE_URL'] || 'https://api.sandbox.prodigi.com'
+  API_VERSION = 'v4.0'
+
+  class << self
+    attr_accessor :logger
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = self.name
+      end
     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-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/pwinty.gemspec

@@ -9,14 +9,14 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Thomas Harvey"]
   spec.email         = ["tom@alush.co.uk"]
 
-  spec.summary       = %q{Order photo prints through Pwinty}
-  spec.description   = "This wraps the Pwinty API at version 3 and aims to make your ruby life easier when interacting with the API."
+  spec.summary       = %q{Order photo prints through the Prodigi Pwinty API}
+  spec.description   = "This wraps the Pwinty API at version 4 and aims to make your ruby life easier when interacting with the API."
   spec.homepage      = "https://github.com/tomharvey/pwinty3-rb"
   spec.license       = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["documentation_uri"] = "https://pwinty.com/api/"
+  spec.metadata["documentation_uri"] = "https://www.prodigi.com/print-api/docs/"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,18 +27,18 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 
-  spec.add_development_dependency "vcr", "~> 5.0"
-  spec.add_development_dependency "webmock", "~> 3.6"
-  spec.add_development_dependency "simplecov", "~> 0.17"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.14"
+  spec.add_development_dependency "simplecov", "~> 0.21"
   spec.add_development_dependency "dotenv", "~> 2.7.5"
 
   spec.add_dependency "dry-struct", "~> 1.0"
-  spec.add_dependency "dry-struct-setters", "~> 0.2"
-  spec.add_dependency "faraday", "~> 0.15"
-  spec.add_dependency "faraday_middleware", "~> 0.13"
-  spec.add_dependency "json", "~> 2.2"
+  spec.add_dependency "dry-struct-setters", "~> 0.4"
+  spec.add_dependency "faraday", "~> 1.0"
+  spec.add_dependency "faraday_middleware", "~> 1.2"
+  spec.add_dependency "json", "~> 2.6"
 end