pwinty 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e2d69fca32fe28bbe4ed607577ebae56276c63b
+  data.tar.gz: 71683c3aec6864253728421f3aad4c0848bea4cf
+SHA512:
+  metadata.gz: c7ade263209666875e70958004b94adddd09a50b73ddcecbce7d25c272450f03561c484fecc35256ac52efd86a9d300390d83614870a91ff261af72bad147bf8
+  data.tar.gz: 25b59d9c7fbc884b0520dc7c0b4a6004e5fd76e86e327785e878cbd252b0a10426a90d5ac544256791cf30567d8ea9b99e691cc5ba062e4f6c3ceabd0e9fe473

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.env

data/.travis.yml

@@ -0,0 +1,5 @@
+bundler_args: ""
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in pwinty.gemspec
+gemspec

data/README.md

@@ -0,0 +1,85 @@
+# Pwinty [![Build Status](https://secure.travis-ci.org/dereklucas/pwinty.png)](http://travis-ci.org/dereklucas/pwinty?branch=master) [![Dependency Status](https://gemnasium.com/dereklucas/pwinty.png)](https://gemnasium.com/dereklucas/pwinty)
+
+This library implements a Ruby client for the [Pwinty photo printing API](http://www.pwinty.com/Api).
+
+Documentation
+-------------
+
+Import pwinty and set your API Key and Merchent ID:
+
+    ENV['PWINTY_MERCHANT_ID'] = 'xxxxxxx'
+    ENV['PWINTY_API_KEY'] = 'xxxxxxx'
+    @client = Pwinty.client
+
+Create an Order:
+
+    order = @client.Order.create_order(
+      recipientName: "FirstName LastName",
+      address1: "123 Anywhere Street",
+      addressTownOrCity: "San Francisco",
+      stateOrCounty: "CA",
+      postalOrZipCode: "94101",
+      countryCode: "US",
+      payment: "InvoiceMe",
+      qualityLevel: "Standard"
+    )
+
+Add photos to the order:
+
+    photo = @client.add_photo(
+      orderId: order['id'],
+      type: "4x6",
+      url: "http://i.imgur.com/xXnrL.jpg",
+      copies: 1,
+      sizing: "Crop"
+    )
+
+Check the order is valid:
+
+  	order_status = @client.get_order_status(order['id'])
+  	if !order_status['isValid']
+  		puts "Invalid Order"
+    end
+
+Submit the order:
+
+    response = @client.update_order_status(order['id'], "Submitted")
+
+
+You can retrieve a previous order and check its status like so:
+
+    order = @client.get_order_status(8765)
+    if order['status'] == 'Complete'
+    	puts "Order has dispatched"
+    end
+
+You should find the documentation for Pwinty on [their API](https://pwinty.com/Api).
+
+Install
+--------
+
+```shell
+gem install pwinty
+```
+or add the following line to Gemfile:
+
+```ruby
+gem 'pwinty'
+```
+and run `bundle install` from your shell.
+
+Supported Ruby versions
+-----------------------
+
+The Ruby Pwinty gem has only been tested on Ruby 2.
+
+License
+-------
+
+MIT License
+
+More Information
+----------------
+
+* [Rubygems](https://rubygems.org/gems/pwinty)
+* [Issues](https://github.com/dereklucas/pwinty/issues)

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+ t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/multipart.rb

@@ -0,0 +1,76 @@
+# License:: Distributed under the terms of the WTFPL (http://www.wtfpl.net/txt/copying/)
+
+require 'rubygems'
+require 'mime/types'
+require 'cgi'
+
+
+module Multipart
+  VERSION = "1.0.0"
+
+  # Formats a given hash as a multipart form post
+  # If a hash value responds to :string or :read messages, then it is
+  # interpreted as a file and processed accordingly; otherwise, it is assumed
+  # to be a string
+  class Post
+    # We have to pretend we're a web browser...
+    USERAGENT = "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en-us) AppleWebKit/523.10.6 (KHTML, like Gecko) Version/3.0.4 Safari/523.10.6"
+    BOUNDARY = "0123456789ABLEWASIEREISAWELBA9876543210"
+    CONTENT_TYPE = "multipart/form-data; boundary=#{ BOUNDARY }"
+    HEADER = { "Content-Type" => CONTENT_TYPE, "User-Agent" => USERAGENT }
+
+    def self.prepare_query(params)
+      fp = []
+
+      params.each do |k, v|
+        # Are we trying to make a file parameter?
+        if v.respond_to?(:path) and v.respond_to?(:read) then
+          fp.push(FileParam.new(k.to_s, v.path, v.read))
+        # We must be trying to make a regular parameter
+        else
+          fp.push(StringParam.new(k.to_s, v))
+        end
+      end
+
+      # Assemble the request body using the special multipart format
+      query = fp.collect {|p| "--" + BOUNDARY + "\r\n" + p.to_multipart }.join("") + "--" + BOUNDARY + "--"
+      return query, HEADER
+    end
+  end
+
+  private
+
+  # Formats a basic string key/value pair for inclusion with a multipart post
+  class StringParam
+    attr_accessor :k, :v
+
+    def initialize(k, v)
+      @k = k
+      @v = v
+    end
+
+    def to_multipart
+      return "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"\r\n\r\n#{v}\r\n"
+    end
+  end
+
+  # Formats the contents of a file or string for inclusion with a multipart
+  # form post
+  class FileParam
+    attr_accessor :k, :filename, :content
+
+    def initialize(k, filename, content)
+      @k = k
+      @filename = filename
+      @content = content
+    end
+
+    def to_multipart
+      # If we can tell the possible mime-type from the filename, use the
+      # first in the list; otherwise, use "application/octet-stream"
+      mime_type = MIME::Types.type_for(filename)[0] || MIME::Types["application/octet-stream"][0]
+      return "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"; filename=\"#{ filename }\"\r\n" +
+             "Content-Type: #{ mime_type.simplified }\r\n\r\n#{ content }\r\n"
+    end
+  end
+end

data/lib/pwinty.rb

@@ -0,0 +1,81 @@
+require "pwinty/version"
+require "multipart"
+require "rest_client"
+
+module Pwinty
+
+  def self.client
+    @@client ||= Pwinty::Client.new
+    @@client
+  end
+
+  class Client
+    def initialize
+      subdomain = ENV['PWINTY_PRODUCTION'] == 'true' ? "api" : "sandbox"
+      domain = "https://#{subdomain}.pwinty.com/v2.1"
+
+      @pwinty = RestClient::Resource.new(domain, :headers => {
+        "X-Pwinty-MerchantId" => ENV['PWINTY_MERCHANT_ID'],
+        "X-Pwinty-REST-API-Key" => ENV['PWINTY_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
+    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)
+    end
+
+    # post :add_photos, "/Orders/:orderId/Photos/Batch"
+    def delete_photo(orderId, photoId)
+      JSON.parse @pwinty["/Orders/#{orderId}/Photos/#{photoId}"].delete
+    end
+
+    # Countries
+    def countries
+      JSON.parse @pwinty["/Country"].get
+    end
+  end
+end

data/lib/pwinty/version.rb

@@ -0,0 +1,3 @@
+module Pwinty
+  VERSION = "1.0.1"
+end

data/pwinty.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+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}
+
+  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"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "dotenv"
+  s.add_runtime_dependency "rest-client", '~> 1.8'
+end

data/test/test_client.rb

@@ -0,0 +1,116 @@
+require "test_helper"
+
+class TestClient < Test::Unit::TestCase
+
+  def setup
+    @params = {
+      recipientName: "FirstName LastName",
+      address1: "123 Anywhere Street",
+      addressTownOrCity: "San Francisco",
+      stateOrCounty: "CA",
+      postalOrZipCode: "94101",
+      countryCode: "US",
+      payment: "InvoiceMe",
+      qualityLevel: "Standard"
+    }
+
+    @client = Pwinty.client
+
+    @order_keys = %w[ id status price
+                      address1 address2
+                      addressTownOrCity
+                      countryCode
+                      destinationCountryCode
+                      errorMessage qualityLevel
+                      payment paymentUrl
+                      photos postalOrZipCode
+                      recipientName shippingInfo
+                      stateOrCounty ]
+  end
+
+  def test_initialize
+    body = @client.catalog
+    assert_equal body.class, Hash
+  end
+
+  def test_catalog_integration
+    body = @client.catalog
+    assert_equal body.class, Hash
+    assert_equal body["countryCode"], "US"
+    assert_equal body["qualityLevel"], "Standard"
+    assert_equal body["shippingRates"].class, Array
+    assert_equal body["items"].class, Array
+  end
+  def test_get_orders_integration
+    body = @client.get_orders
+    assert_equal body.class, Array
+    assert_equal body.first.keys.sort!, @order_keys.sort!
+  end
+  def test_countries_integration
+    body = @client.countries
+    keys = %w[ countryCode name
+               hasProducts errorMessage ]
+
+    assert_equal body.class, Array
+    assert_equal body.first.keys.sort!, keys.sort!
+  end
+
+  def test_orders_integration
+    # create Order
+    body = @client.create_order(@params)
+    assert_equal body.keys.sort!, @order_keys.sort!
+    assert_equal body["postalOrZipCode"], "94101"
+    id = body["id"]
+
+
+    body = @client.update_order(id: id, recipientName: 'Travis CI', postalOrZipCode: '94102')
+    assert_equal body.keys.sort!, @order_keys.sort!
+    assert_equal body["postalOrZipCode"], "94102"
+
+    # add Photo to Order via URL
+    body = @client.add_photo(orderId: id,
+                             type: "4x6",
+                             url: "http://i.imgur.com/xXnrL.jpg",
+                             copies: 1, sizing: "Crop")
+    photo_id = body['id']
+    first_photo = body
+
+    keys = %w[ id type url
+               status copies
+               sizing priceToUser
+               price md5Hash previewUrl
+               thumbnailUrl attributes
+               errorMessage ]
+
+    assert_equal body.keys.sort!, keys.sort!
+
+    # Check photo was uploaded
+    body = @client.get_photos(id)
+    assert_equal body.length, 1
+    assert_equal body.first, first_photo
+
+    # Check photo was uploaded
+    body = @client.get_photo(id, photo_id)
+    assert_equal body, first_photo
+
+    # Delete photo
+    body = @client.delete_photo(id, photo_id)
+    assert_equal body['errorMessage'], nil
+
+    # TODO: Need to add a photo via file
+
+    # get Order Status
+    body = @client.get_order_status(id)
+    keys = %w[id isValid generalErrors photos]
+    if body["error"]
+      assert body["error"].class, String
+    else
+      assert_equal body.keys.sort!, keys.sort!
+    end
+
+    # Cancel Order
+    body = @client.update_order_status(id, "Cancelled")
+    assert_equal body['errorMessage'], nil
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'dotenv'
+Dotenv.load
+
+require 'test-unit'
+require 'pwinty'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: pwinty
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Derek Lucas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Order photo prints with Ruby
+email:
+- d@derekplucas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/multipart.rb
+- lib/pwinty.rb
+- lib/pwinty/version.rb
+- pwinty.gemspec
+- test/test_client.rb
+- test/test_helper.rb
+homepage: http://github.com/dereklucas/pwinty
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby client for the Pwinty API
+test_files:
+- test/test_client.rb
+- test/test_helper.rb
+has_rdoc: