square-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fb70a8ab623fe06ffc5bacf8a0f73162b7ae080
+  data.tar.gz: f1a82cef0bd9b6cc60e3038246c03854b2db6f18
+SHA512:
+  metadata.gz: 0de23e6cabf0cbf6bf84ae037c94f9c704ed33711ddebc11a2a739db73b2db951cbfa3067b3bf7d5246edf29ce965480327b4dbd3279a64220a6e630515eacd9
+  data.tar.gz: 1fc688b1c832c39ac3b587e16e68b90276e9a71e90cfbd4be334c6258a44e8b73b412b96e70c39451b15ed8c10a1caf6f0e6f2e1634106764b9653ad6cedd9a4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+rvm:
+  - 2.2.2
+
+before_install: gem install bundler -v 1.10.6
+
+script:
+  - bundle exec rspec
+
+addons:
+  code_climate:
+    repo_token: a5d17f579fe85df5c2f4cd7cc895c30463b763d42d48dd0e09a44adc10dd7356

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in square-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Brian McAllister
+
+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,73 @@
+# Square Connect API
+
+[![Code Climate](https://codeclimate.com/github/giantmachines/square-ruby/badges/gpa.svg)](https://codeclimate.com/github/giantmachines/square-ruby) [![Test Coverage](https://codeclimate.com/github/giantmachines/square-ruby/badges/coverage.svg)](https://codeclimate.com/github/giantmachines/square-ruby/coverage) [![Build Status](https://travis-ci.org/giantmachines/square-ruby.svg?branch=master)](https://travis-ci.org/giantmachines/square-ruby)
+
+The Square Connect API gem provides access to the Square Connect API.
+
+TODO:
+
+- [ ] Update RestClient.
+- [ ] Add all data types.  
+- [ ] Add all API resources.
+- [ ] OAuth.
+- [x] Batching.
+- [x] Handle multi location.
+- [ ] Employee management.
+- [ ] Register API?
+
+## Documentation
+
+[Square Connect](https://docs.connect.squareup.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'square-ruby', require: 'square'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install square-ruby
+
+## Usage
+
+TODO
+
+...but quickly, use one of the methods on one of the `APIResource` subclasses, e.g.
+
+`items = Square::Item.list`
+
+You'll now have an array of `Square::DataType::Item`s.
+
+#### Paging
+
+Paging only works for `APIResource#list`.
+
+```
+resp = Square::Payment.list({limit: 10})
+resp.each {|p| puts p.id }
+
+puts "got #{resp.count}. getting more"
+
+while resp.has_more?
+  puts "has more"
+  more = resp.more
+  more.each {|p| puts p.id }
+end
+
+puts 'done'
+```
+
+## Development
+
+TODO
+
+## Contributing
+
+TODO

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "square/ruby"
+
+# 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

data/bin/setup

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

data/lib/square.rb

@@ -0,0 +1,206 @@
+# Libs.
+require 'rest-client'
+require 'hashie'
+require 'open-uri'
+require 'net/http/post/multipart'
+
+# Version.
+require 'square/version'
+
+# Data types.
+require 'square/data_type'
+require 'square/data_types/money'
+require 'square/data_types/device'
+require 'square/data_types/payment_discount'
+require 'square/data_types/payment_tax'
+require 'square/data_types/payment_modifier'
+require 'square/data_types/payment_item_detail'
+require 'square/data_types/payment_itemization'
+require 'square/data_types/refund'
+require 'square/data_types/tender'
+require 'square/data_types/payment'
+require 'square/data_types/fee'
+require 'square/data_types/item_image'
+require 'square/data_types/category'
+require 'square/data_types/item_variation'
+require 'square/data_types/modifier_list'
+require 'square/data_types/modifier_option'
+require 'square/data_types/item'
+require 'square/data_types/settlement_entry'
+require 'square/data_types/settlement'
+require 'square/data_types/coordinates'
+require 'square/data_types/global_address'
+require 'square/data_types/phone_number'
+require 'square/data_types/merchant_location_details'
+require 'square/data_types/merchant'
+require 'square/data_types/discount'
+require 'square/data_types/inventory_entry'
+require 'square/data_types/bank_account'
+
+# API Operations.
+require 'square/list_response'
+require 'square/api_operations/list'
+require 'square/api_operations/retrieve'
+require 'square/api_operations/create'
+require 'square/api_operations/update'
+require 'square/api_operations/delete'
+
+# API Resources.
+require 'square/api_resource'
+require 'square/category'
+require 'square/bank_accounts'
+require 'square/discount'
+require 'square/item'
+require 'square/merchant'
+require 'square/payment'
+require 'square/inventory'
+require 'square/fee'
+require 'square/refund'
+require 'square/settlement'
+require 'square/variation'
+require 'square/webhook'
+
+RestClient.log = Logger.new(STDOUT)
+
+module Square
+  @api_host = 'https://connect.squareup.com'
+  @access_token = nil
+  @api_version = 'v1'
+  @merchant_id = 'me'
+
+  class << self
+    attr_accessor :api_host, :access_token, :api_version, :merchant_id
+  end
+
+  # Make an API call to Square.
+  #
+  # @param options [Hash] Hash of options. Expects something like this:
+  #
+  # {
+  #   method: 'POST',
+  #   endpoint: 'items',
+  #   request: {...}
+  # }
+  #
+  # @return [RestClient::Response]
+  def self.make_request(options = {}, &block)
+    if access_token.nil?
+      raise StandardError.new('No access token set.')
+    end
+
+    # Default to a GET request.
+    method = (options[:method] || :get).downcase.to_sym
+
+    # Allow passing in a fully formed URL.
+    if !options[:url].nil?
+      url = options[:url]
+    else
+      merchant = options[:merchant] || merchant_id
+
+      # Special handling of the merchant param.
+      if !options[:params].nil? && !options[:params][:merchant].nil?
+        merchant = options[:params].delete(:merchant)
+      end
+
+      if !options[:payload].nil? && !options[:payload][:merchant].nil?
+        merchant = options[:payload].delete(:merchant)
+      end
+
+      path_args = [api_host, api_version, merchant, options[:endpoint]].compact
+      url = File.join(path_args)
+    end
+
+    # Build up the RestClient request object.
+    request_params = {
+      headers: request_headers(access_token).merge(options[:headers] || {}),
+      method: method,
+      url: url
+    }
+
+    # Merge in a payload hash.
+    payload = options[:payload] || nil
+
+    if !payload.nil? && payload.respond_to?(:to_json) && !payload.empty?
+      payload = payload.to_json
+      request_params.merge!(payload: payload)
+    end
+
+    # Merge in a params hash.
+    params = options[:params] || nil
+
+    if !params.nil? && !params.empty?
+      request_params[:headers].merge!(params: params)
+    end
+
+    # Perform the request.
+    self.request(request_params, &block)
+  end
+
+  # Request helper. Makes testing and switching out the http client easy.
+  def self.request(request, &block)
+    RestClient::Request.execute(request, &block)
+  end
+
+  # Parse a response.
+  #
+  # @param response [RestClient::Response]
+  #
+  # @return [#to_json]
+  def self.parse_response(response)
+    begin
+      JSON.parse(response, symbolize_names: true)
+    rescue RestClient::Exception => e
+      Logger.new(STDOUT).error(e.http_body)
+      raise e
+    end
+  end
+
+  # {
+  #   method: "POST",
+  #   path: "categories",
+  #   body: {
+  #     "name": "Beverages"
+  #   }
+  # }
+  def self.batch(requests = [{}], options = {}, &block)
+    merchant = options[:merchant] || 'me'
+
+    requests = requests.map {|request|
+      path = request.delete(:path)
+      request[:relative_path] = File.join('/', 'v1', merchant, path)
+      request[:access_token]  = access_token
+      request[:request_id]    ||= SecureRandom.uuid
+      request
+    }
+
+    request_params = {
+      headers: request_headers(access_token),
+      method: :post,
+      url: File.join(api_host, 'v1', 'batch'),
+      payload: {
+        requests: requests
+      }.to_json
+    }
+
+    begin
+      response = RestClient::Request.execute(request_params, &block)
+      JSON.parse(response)
+    rescue RestClient::Exception => e
+      Logger.new(STDOUT).error(e.http_body)
+      raise e
+    end
+  end
+
+  # Get the request headers.
+  #
+  # @param [String] Square access token.
+  #
+  # @return [Hash] Hash of headers.
+  def self.request_headers(access_token)
+    {
+      authorization: "Bearer #{access_token}",
+      accept: 'application/json',
+      content_type: 'application/json'
+    }
+  end
+end

data/lib/square/api_operations/create.rb

@@ -0,0 +1,30 @@
+module Square
+  module APIOperations
+    module Create
+      # Create resource.
+      #
+      # @param parent_id [String] ID of the 'parent' to update. Optional.
+      # @param params [Hash] Payload. Optional.
+      #
+      # @return [DataType]
+      def create(*args)
+        if args.count == 1
+          parent_id = nil
+          params = args[0]
+        elsif args.count == 2
+          parent_id = args[0]
+          params = args[1]
+        end
+
+        response = Square.make_request(
+          method: 'POST',
+          endpoint: self.generate_endpoint_url(nil, parent_id),
+          payload: params
+        )
+
+        response = Square.parse_response(response)
+        @data_type.new(response)
+      end
+    end
+  end
+end

data/lib/square/api_operations/delete.rb

@@ -0,0 +1,24 @@
+module Square
+  module APIOperations
+    module Delete
+      # Delete a resource.
+      #
+      # @param id [String] ID of the resource to update.
+      # @param parent_id [String] ID of the 'parent' to update. Optional.
+      # @param params [Hash] Payload. Optional.
+      #
+      # @return [#to_json]
+      def delete(*args, params)
+        id, parent_id = args
+
+        response = Square.make_request(
+          method: 'DELETE',
+          endpoint: self.generate_endpoint_url(id, parent_id),
+          payload: params
+        )
+
+        Square.parse_response(response)
+      end
+    end
+  end
+end

data/lib/square/api_operations/list.rb

@@ -0,0 +1,21 @@
+module Square
+  module APIOperations
+    module List
+      # List resource.
+      #
+      # @param params [Hash] Hash of query params. Optional.
+      #
+      # @return [Square::ListResponse]
+      def list(params = {})
+        # The list endpoint makes use of the ListResponse to handle paging.
+        response = Square.make_request(
+          method: 'GET',
+          endpoint: self.generate_endpoint_url,
+          params: params
+        )
+
+        Square::ListResponse.new(response, @data_type)
+      end
+    end
+  end
+end