pwinty 1.1.0 → 3.0.0

data/Rakefile

@@ -1,11 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-require "bundler/gem_tasks"
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
- t.libs << 'test'
-end
+RSpec::Core::RakeTask.new(:spec)
 
-desc "Run tests"
-task :default => :test
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pwinty3"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pwinty.rb

@@ -1,88 +1,62 @@
+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"
-require "multipart"
-require "rest_client"
 
 module Pwinty
+    class Error < StandardError; end
+    class AuthenticationError < Pwinty::Error; end
+    class OrderNotFound < Pwinty::Error; end
+    class StateIsInvalid < Pwinty::Error; end
 
-  def self.client(args={})
-    @@client ||= Pwinty::Client.new(args)
-    @@client
-  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 Client
-    attr_accessor :pwinty
-    def initialize(args={})
-      options = { merchant_id: ENV['PWINTY_MERCHANT_ID'], api_key: ENV['PWINTY_API_KEY'], production: ENV['PWINTY_PRODUCTION'] == 'true' }.merge(args)
-      subdomain = options[:production] == true ? "api" : "sandbox"
-      apiVersion = options[:api_version] || 'v2.1'
-      domain = "https://#{subdomain}.pwinty.com/#{apiVersion}"
-
-      @pwinty = RestClient::Resource.new(domain, :headers => {
-        "X-Pwinty-MerchantId" => options[:merchant_id],
-        "X-Pwinty-REST-API-Key" => options[:api_key],
-        'Accept' => 'application/json'
-      })
-    end
-
-    def catalog(countryCode: 'US', qualityLevel: 'Standard')
-      JSON.parse @pwinty["/Catalogue/#{countryCode}/#{qualityLevel}"].get
-    end
-
-    # Orders
-    def get_orders
-      JSON.parse @pwinty["/Orders"].get
-    end
-
-    def create_order(**args)
-      JSON.parse @pwinty["/Orders"].post(args)
-    end
-
-    def update_order(**args)
-      JSON.parse @pwinty["/Orders/#{args[:id]}"].put(args)
-    end
-
-    # Order Status
-    def get_order_status(id)
-      JSON.parse @pwinty["/Orders/#{id}/SubmissionStatus"].get
-    end
-
-    def update_order_status(id, status)
-      JSON.parse @pwinty["/Orders/#{id}/Status"].post(status: status)
-    end
-
-    # Order Photos
-    def get_photos(orderId)
-      JSON.parse @pwinty["/Orders/#{orderId}/Photos"].get
+    class << self
+        attr_accessor :logger
+        def logger
+            @logger ||= Logger.new($stdout).tap do |log|
+                log.progname = self.name
+            end
+        end
     end
 
-    def get_photo(orderId, photoId)
-      JSON.parse @pwinty["/Orders/#{orderId}/Photos/#{photoId}"].get
-    end
-
-
-    def add_photo(**args)
-      headers = {}
-      orderId = args.delete(:orderId)
-
-      unless args[:file].nil?
-        args, headers = Multipart::Post.prepare_query(args)
-      end
-
-      JSON.parse @pwinty["/Orders/#{orderId}/Photos"].post(args, headers)
+    def self.url
+        "#{Pwinty::BASE_URL}/#{Pwinty::API_VERSION}/"
     end
 
-    def add_photos(orderId, photos)
-      body = photos.is_a?(String) ? photos : photos.to_json
-      JSON.parse @pwinty["/Orders/#{orderId}/Photos/Batch"].post(body, {'Content-Type' => 'application/json'} )
+    def self.headers
+        {
+            'X-Pwinty-MerchantId' => Pwinty::MERCHANT_ID,
+            'X-Pwinty-REST-API-Key' => Pwinty::API_KEY,
+        }
     end
 
-    def delete_photo(orderId, photoId)
-      JSON.parse @pwinty["/Orders/#{orderId}/Photos/#{photoId}"].delete
+    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
 
-    # Countries
-    def countries
-      JSON.parse @pwinty["/Country"].get
+    def self.collate_results(response_data, classType)
+        collection = []
+        response_data.each do |individual_attr|
+            collection << classType.new(individual_attr)
+        end
+        collection
     end
-  end
 end

data/lib/pwinty/base.rb

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

data/lib/pwinty/country.rb

@@ -0,0 +1,12 @@
+module Pwinty
+
+	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
+end

data/lib/pwinty/http_errors.rb

@@ -0,0 +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::OrderNotFound, msg
+			when 500; raise Pwinty::Error, msg
+			end
+		end
+	end
+end

data/lib/pwinty/image.rb

@@ -0,0 +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,
+			frame: Types::String,
+			edge: Types::String,
+			paperType: Types::String,
+			frameColour: Types::String,
+		).optional
+		attribute :errorMessage, Types::String.optional
+	end
+end

data/lib/pwinty/order.rb

@@ -0,0 +1,110 @@
+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 :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
+            response = Pwinty.conn.get("orders?count=250&offset=0")
+            r_data = response.body['data']
+            # TODO There is some bug with offset in the API.
+            # total_count = r_data['count']
+            Pwinty.collate_results(r_data['content'], self)
+        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)
+            images = Pwinty.collate_results(response.body['data']['items'], Pwinty::Image)
+            self.images = self.images + 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
+
+    end
+end

data/lib/pwinty/order_status.rb

@@ -0,0 +1,17 @@
+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)
+		
+
+		def self.check(id)
+	      	response = Pwinty.conn.get("orders/#{id}/SubmissionStatus")
+	      	new(response.body['data'])
+	    end
+	end
+end

data/lib/pwinty/photo_status.rb

@@ -0,0 +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
+end

data/lib/pwinty/shipment.rb

@@ -0,0 +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
+end

data/lib/pwinty/shipping_info.rb

@@ -0,0 +1,9 @@
+require "pwinty/shipment"
+
+module Pwinty
+
+	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 = "1.1.0"
+  VERSION = "3.0.0"
 end

data/pwinty.gemspec

@@ -1,24 +1,39 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "pwinty/version"
 
-Gem::Specification.new do |s|
-  s.name        = "pwinty"
-  s.version     = Pwinty::VERSION
-  s.authors     = ["Derek Lucas"]
-  s.email       = ["d@derekplucas.com"]
-  s.homepage    = "http://github.com/dereklucas/pwinty"
-  s.licenses    = ['MIT']
-  s.summary     = %q{A Ruby client for the Pwinty API}
-  s.description = %q{Order photo prints with Ruby}
+Gem::Specification.new do |spec|
+  spec.name          = "pwinty"
+  spec.version       = Pwinty::VERSION
+  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.homepage      = "https://github.com/tomharvey/pwinty3-rb"
+  spec.license       = "MIT"
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.add_development_dependency "vcr", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.6"
+  spec.add_development_dependency "simplecov", "~> 0.17"
 
-  s.add_development_dependency "rake"
-  s.add_development_dependency "test-unit"
-  s.add_development_dependency "dotenv"
-  s.add_runtime_dependency "rest-client", '~> 1.8'
+  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"
 end