squarespace 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd1f06c3ed79a3dfab23b4c5457efa992f47fa1e
+  data.tar.gz: 1e883c51f91e47e2ad0ea99ed8e436c6be9f04a9
+SHA512:
+  metadata.gz: cfc1f3653130d3621ca580c6dcc17d02d1b9ccc5467b26c13a622b74cdec9da44eceb618141810f36d835a8dc857ca89665c2eba4f20476cf79726ea498ee0cf
+  data.tar.gz: 0ed4054566485d9aae747f56cc48e2a2d39618c7e67f4330a505d73ac74d928fd64b2e880daf9d00fd00f5d9733a80eb75ba4ff4a71b1e5f6c2ae5a183c9bbda

data/.gitignore

@@ -0,0 +1,2 @@
+coverage
+.rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    squarespace (0.0.1)
+      faraday
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    coderay (1.1.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    faraday (0.12.1)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.4)
+    json (2.1.0)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    public_suffix (2.0.5)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    safe_yaml (1.0.4)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    slop (3.6.0)
+    timecop (0.9.1)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  pry
+  rspec
+  simplecov
+  squarespace!
+  timecop
+  webmock
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Gabe Ochoa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# SquareSpace Commerce API
+
+[![Gem Version](https://badge.fury.io/rb/squarespace.svg)](https://badge.fury.io/rb/squarespace)
+
+Ruby gem for interacting with the Squarespace API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'squarespace'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install squarespace
+
+
+# Example usage
+
+## Initializing the client
+```
+client = Squarespace::Client.new(
+  app_name: 'YOUR_APP_NAME'
+  app_secret: 'YOUR_CLIENT_SECRET'
+)
+```
+## Get an order
+```
+client.get_order(order_id)
+```
+## Get all orders
+```
+client.get_orders
+```
+## Get all orders with a specified fulfillment status
+```
+client.get_orders('pending')
+client.get_orders('fulfilled')
+client.get_orders('canceled')
+```
+## Fulfill an order
+```
+client.fulfill_order(order_id, shipments, send_notification)
+```
+
+	`shipments` is a hash array in the form of
+
+```      
+[{
+  tracking_number: 'test_tracking_number1',
+  tracking_url: 'https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=test_tracking_number2',
+  carrier_name: 'USPS',
+  service: 'ground'
+},{
+  tracking_number: 'test_tracking_number2',
+  tracking_url: nil,
+  carrier_name: 'USPS',
+  service: 'prioritt'
+}]
+``` 
+
+
+# Testing
+
+`bundle exec rspec`
+

data/lib/squarespace.rb

@@ -0,0 +1,17 @@
+require 'squarespace/client'
+require 'squarespace/configuration'
+require 'squarespace/order'
+require 'squarespace/version'
+
+module Squarespace
+
+  def self.configuration
+    @configuration
+  end
+
+  def self.configure(options = {})
+    @configuration = Configuration.new(options)
+    yield(configuration) if block_given?
+    self.configuration
+  end
+end

data/lib/squarespace/client.rb

@@ -0,0 +1,107 @@
+require 'faraday'
+require 'json'
+require 'logger'
+require 'time'
+
+module Squarespace
+  class Client
+    attr_reader :commerce_url, :logger
+
+    COMMERCE_API_VERSION = 0.1
+
+    def initialize(options={})
+      @logger = Logger.new(STDOUT)
+      @logger.level = options.delete('log_level') || 'INFO'
+      @config = Squarespace::Config.new(options)
+      @commerce_url = "#{@config.api_url}/#{COMMERCE_API_VERSION}/commerce/orders"
+    end
+
+    def get_order(id)
+      order_response = commerce_request('get', id.to_s)
+      logger.debug("Order response: #{order_response.body}")
+      Order.new(JSON.parse(order_response.body))
+    end
+
+    def get_orders(fulfillment_status = nil)
+      if fulfillment_status.nil?
+        order_response = commerce_request('get')
+      else
+        # binding.pry
+        order_response = commerce_request('get', '', {}, 
+          {"fulfillmentStatus"=>fulfillment_status.upcase})
+      end
+
+      logger.debug("Order response: #{order_response.body}")
+      Order.new(JSON.parse(order_response.body))
+    end
+
+    def get_pending_orders
+      get_orders('pending')
+    end
+
+    def get_fulfilled_orders
+      get_orders('fulfilled')
+    end
+
+    def fulfill_order(order_id, shipments, send_notification=true)
+      # fulfill_order(string, array[hash], boolean)
+      #
+      # Shipment array example:
+      # 
+      # [{
+      #   tracking_number: 'test_tracking_number1',
+      #   tracking_url: 'https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=test_tracking_number2',
+      #   carrier_name: 'USPS',
+      #   service: 'ground'
+      # },{
+      #   tracking_number: 'test_tracking_number2',
+      #   tracking_url: nil,
+      #   carrier_name: 'USPS',
+      #   service: 'prioritt'
+      # }]
+
+      shipments_arry = []
+      
+      shipments.each do |shipment|
+        shipments_arry << {
+          "carrierName": shipment[:carrier_name],
+          "service": shipment[:service],
+          "shipDate": "#{Time.now.utc.iso8601}",
+          "trackingNumber": shipment[:tracking_number],
+          "trackingUrl": shipment[:tracking_url]
+        }
+      end
+      
+      request_body = {
+        "shipments": shipments_arry,
+        "shouldSendNotification": send_notification
+      }
+      
+      commerce_request('post', "#{order_id}/fulfillments", {}, {}, request_body.to_json)
+    end
+
+    def commerce_request(method, route='', headers={}, parameters={}, body=nil)
+      response = connection(@commerce_url).send(method.downcase) do |req|
+        if method.eql?('post')
+          req.headers['Content-Type'] = 'application/json'
+        end
+        parameters.each { |k,v| req.params["#{k}"] = v } if parameters.any?
+        headers.each { |k,v| req.headers["#{k}"] = v } if headers.any?
+
+        # We always need an Authorization header
+        req.headers['Authorization'] = "Bearer #{@config.api_key}"
+        req.url route
+        req.body = body unless body.nil?
+      end
+    end
+
+    private
+
+    def connection(url)
+      Faraday.new(url: url) do |faraday|
+        faraday.request  :url_encoded
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/squarespace/configuration.rb

@@ -0,0 +1,13 @@
+module Squarespace
+  class Config
+    attr_reader :api_url, :api_key, :app_name
+
+    def initialize(options)
+      @api_url = options[:api_url] || "https://api.squarespace.com"
+
+      # No default values
+      @app_name = options[:app_name]
+      @api_key = options[:api_key]
+    end
+  end
+end

data/lib/squarespace/order.rb

@@ -0,0 +1,7 @@
+require 'ostruct'
+
+module Squarespace
+  class Order < OpenStruct
+    ;
+  end
+end

data/lib/squarespace/version.rb

@@ -0,0 +1,3 @@
+module Squarespace
+  VERSION = '0.0.3'
+end

data/spec/fixtures/fulfill_order_body.json

@@ -0,0 +1,19 @@
+{
+  "shipments": [
+    {
+      "carrierName": "USPS",
+      "service": "ground",
+      "shipDate": "2017-01-29T22:19:26.980Z",
+      "trackingNumber": "test_tracking_number1",
+      "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=test_tracking_number2"
+    },
+    {
+      "carrierName": "USPS",
+      "service": "priority",
+      "shipDate": "2017-01-29T22:19:26.980Z",
+      "trackingNumber": "test_tracking_number2",
+      "trackingUrl": null
+    }
+  ],
+  "shouldSendNotification": true
+}

data/spec/fixtures/fulfilled_orders_response.json

@@ -0,0 +1,146 @@
+{
+  "pagination": {
+    "hasNextPage": false,
+    "nextPageCursor": null,
+    "nextPageUrl": null
+  },
+  "result": [
+    {
+      "billingAddress": {
+        "address1": "459 Broadway",
+        "address2": null,
+        "city": "New York",
+        "countryCode": "US",
+        "firstName": "Bob",
+        "lastName": "Loblaw",
+        "phone": "5553334444",
+        "postalCode": "10003",
+        "state": "NY"
+      },
+      "createdOn": "2016-12-23T15:58:07.187Z",
+      "customerEmail": "foo@example.com",
+      "discountLines": [
+        {
+          "amount": {
+            "currency": "USD",
+            "value": "1.00"
+          },
+          "description": "Fall Sale",
+          "promoCode": "FALLSALE"
+        }
+      ],
+      "discountTotal": {
+        "currency": "USD",
+        "value": "1.00"
+      },
+      "formSubmission": [
+        {
+          "label": "How did you hear about us?",
+          "value": "Facebook"
+        }
+      ],
+      "fulfillmentStatus": "FULFILLED",
+      "fulfillments": [],
+      "grandTotal": {
+        "currency": "USD",
+        "value": "57.70"
+      },
+      "id": "585d498fdee9f31a60284a37",
+      "internalNotes": [
+        {
+          "content": "First note"
+        },
+        {
+          "content": "Second note"
+        }
+      ],
+      "lineItems": [
+        {
+          "customizations": null,
+          "id": "585d4975dee9f31a60284a16",
+          "imageUrl": "https://static.squarespace.com/universal/commerce/images/brine-32oz-spring-mix-v2.jpg?format=300w",
+          "productId": "565c8f3da7c8a3cf71d5fd0a",
+          "productName": "Product",
+          "quantity": 1,
+          "sku": "SQ3381024",
+          "unitPricePaid": {
+            "currency": "USD",
+            "value": "55.00"
+          },
+          "variantOptions": [
+            {
+              "optionName": "Size",
+              "value": "Large"
+            },
+            {
+              "optionName": "Color",
+              "value": "Black"
+            }
+          ]
+        },
+        {
+          "customizations": null,
+          "id": "585d4975dee9f31a60284a16",
+          "imageUrl": "https://static.squarespace.com/universal/commerce/images/brine-32oz-spring-mix-v2.jpg?format=300w",
+          "productId": "565c8f3da7c8a3cf71d5fd0a",
+          "productName": "Product",
+          "quantity": 1,
+          "sku": "SQ3381024",
+          "unitPricePaid": {
+            "currency": "USD",
+            "value": "55.00"
+          },
+          "variantOptions": [
+            {
+              "optionName": "Size",
+              "value": "Large"
+            },
+            {
+              "optionName": "Color",
+              "value": "Black"
+            }
+          ]
+        }
+      ],
+      "modifiedOn": "2016-12-23T15:58:07.187Z",
+      "orderNumber": "3",
+      "refundedTotal": {
+        "currency": "USD",
+        "value": "0.00"
+      },
+      "shippingAddress": {
+        "address1": "459 Broadway",
+        "address2": null,
+        "city": "New York",
+        "countryCode": "US",
+        "firstName": "Bob",
+        "lastName": "Loblaw",
+        "phone": "5553334444",
+        "postalCode": "10003",
+        "state": "NY"
+      },
+      "shippingLines": [
+        {
+          "amount": {
+            "currency": "USD",
+            "value": "1.00"
+          },
+          "method": "Flat Rate"
+        }
+      ],
+      "shippingTotal": {
+        "currency": "USD",
+        "value": "1.00"
+      },
+      "subtotal": {
+        "currency": "USD",
+        "value": "55.00"
+      },
+      "taxTotal": {
+        "currency": "USD",
+        "value": "2.70"
+      },
+      "testmode": true
+    }
+  ]
+}