payable-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62e43563cc237b54ebf8a20629b051ed8ccd6128
+  data.tar.gz: 35dcb616a0e214f2bcb54bd6ca9fbc1c8e02ea4b
+SHA512:
+  metadata.gz: 5ec2eb0bbf1427ce9e8f6b904ca8e9f098ba25d2a1b96f028a8ab33b3cc2242ed487eb1c3ea56f81b2bf23462ff2a50faae92d9eb1ecccaa772e883b89ef4db0
+  data.tar.gz: 819f729d1fca4b6e64f9ac203eec21bf1f5e8c4b5b818b03c160e29aad5d2ce6094a271e5f9f2828196a580462f2443176a6e31afb542d07798427d4f1cb18c6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Adam Lassek
+
+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,39 @@
+# Payable
+[![CI Status](https://travis-ci.org/alassek/payable-api.svg?branch=master)](https://travis-ci.org/alassek/payable-api)
+
+A simple API client for [Payable.com](https://payable.com).
+
+This is *alpha software* and not officially sponsored by Payable in any way, so
+use at your own risk.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'payable-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install payable-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alassek/payable-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "payable"
+require "pry"
+
+Pry.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/payable.rb

@@ -0,0 +1,62 @@
+require 'dry/configurable'
+
+module Payable
+  extend Dry::Configurable
+
+  setting :api_url, 'https://api.payable.com/v1/'
+  setting :logger
+  setting :page_size, 50
+
+  setting :company_id
+  setting :api_key
+
+  def self.api_url
+    Addressable::URI.parse config.api_url
+  end
+
+  def self.client
+    @client ||= Client.new
+  end
+
+  def self.client=(instance)
+    @client = instance
+  end
+
+  Error                  = Class.new(StandardError)
+  MissingRequiredSetting = Class.new(Error)
+
+  class InvalidRequest < Error
+    attr_reader :response
+
+    def initialize(response = {})
+      @response = response
+      super
+    end
+
+    def response?
+      return false if response.nil?
+      return false if response.respond_to?(:empty?) && response.empty?
+      !!response
+    end
+
+    def status
+      return nil unless response
+      response[:status]
+    end
+
+    def headers
+      return nil unless response
+      response[:headers]
+    end
+
+    def body
+      return nil unless response
+      respose[:body]
+    end
+  end
+end
+
+require 'payable/types'
+require 'payable/client'
+require 'payable/resource'
+require 'payable/resource_list'

data/lib/payable/client.rb

@@ -0,0 +1,31 @@
+require 'faraday'
+require 'forwardable'
+require 'addressable/uri'
+require 'payable/middleware'
+
+module Payable
+  class Client
+    extend Forwardable
+
+    attr_reader :company_id, :api_key
+
+    def initialize(company_id: Payable.config.company_id, api_key: Payable.config.api_key)
+      @company_id = company_id or raise MissingRequiredSetting, "company_id"
+      @api_key = api_key or raise MissingRequiredSetting, "api_key"
+    end
+
+    def connection
+      @connection ||= Faraday.new Payable.api_url do |conn|
+        conn.basic_auth company_id, api_key
+        conn.request :json
+        conn.response :json
+        conn.response :logger, Payable.config.logger, bodies: true if Payable.config.logger
+        conn.response :symbolize_keys
+        conn.response :raise_error
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def_delegators :connection, :get, :post
+  end
+end

data/lib/payable/middleware.rb

@@ -0,0 +1,34 @@
+require 'faraday_middleware'
+require 'faraday/response'
+
+module Payable
+  module Middleware
+    class SymbolizeKeys < FaradayMiddleware::ParseJson
+      define_parser do |body|
+        break if body.strip.empty?
+        symbolize_keys ::JSON.parse(body)
+      end
+
+      def self.symbolize_keys(hash)
+        hash.inject({}) do |result, (key, value)|
+          new_key = case key
+          when String then key.to_sym
+          else key
+          end
+
+          new_value = case value
+          when Hash then symbolize_keys(value)
+          when Array then value.map{|v| symbolize_keys(v) }
+          else value
+          end
+
+          result[new_key] = new_value
+
+          result
+        end
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware symbolize_keys: Payable::Middleware::SymbolizeKeys

data/lib/payable/payment.rb

@@ -0,0 +1,10 @@
+module Payable
+  class Payment < Resource
+    attribute :worker_id, Types::Strict::Int
+    attribute :amount, Types::Coercible::Int
+    attribute :status, Types::PaymentStatus
+    attribute :notes, Types::String
+    attribute :sent_at, Types::Form::DateTime
+    attribute :paid_at, Types::Form::DateTime
+  end
+end

data/lib/payable/resource.rb

@@ -0,0 +1,51 @@
+require 'dry/struct'
+require 'addressable/template'
+
+module Payable
+  class Resource < Dry::Struct
+    constructor_type :schema
+
+    attribute :id, Types::Strict::Int
+    attribute :created_at, Types::Form::DateTime
+    attribute :updated_at, Types::Form::DateTime
+
+    def self.api_url
+      Addressable::URI.parse Payable.config.api_url
+    end
+
+    def self.url_template
+      Addressable::Template.new api_url.join("#{collection}/{id}")
+    end
+
+    def self.retrieve(id, client: Payable.client, params: {})
+      response = client.get(url_template.expand(id: id), params)
+
+      new(response.body)
+    end
+
+    def self.collection
+      raise NotImplementedError if self == Payable::Resource
+
+      @collection ||= begin
+        collection = name.split('::').last
+        collection = collection.split(/(?=[A-Z])/).map(&:downcase)
+
+        "#{ collection.join('_') }s"
+      end
+    end
+
+    def self.list(options = {})
+      ResourceList.new(self, options)
+    end
+
+    def url
+      self.class.url_template.expand(id: id)
+    end
+  end
+end
+
+require 'payable/writeable'
+require 'payable/worker'
+require 'payable/work_type'
+require 'payable/work'
+require 'payable/payment'

data/lib/payable/resource_list.rb

@@ -0,0 +1,69 @@
+module Payable
+  class ResourceList
+    include Enumerable
+
+    attr_reader :type, :collection, :resource_url, :page_size, :pages, :params
+
+    def initialize(type, options = {})
+      @type = case type
+      when Symbol, String then Payable.const_get(type)
+      else type
+      end
+
+      @collection   = @type.collection
+      @resource_url = Payable.api_url.join(collection)
+      @client       = options.delete(:client){ Payable.client }
+      @page_num     = options.delete(:page_num){ 1 }
+      @page_size    = options.delete(:page_size){ Payable.config.page_size }
+      @page_size    = 50 if @page_size < 1
+      @page_size    = 250 if @page_size > 250
+      @params       = options
+      @pages        = {}
+    end
+
+    alias :all :to_a
+
+    def [](index)
+      index = (length + index) if index < 0
+      page_num, offset = index.divmod(page_size)
+      page(page_num + 1)[offset]
+    end
+
+    def page(num)
+      @pages[num] ||= begin
+        response = get(page: num)
+        @total_count = response.body[:total_count]
+        map response.body[collection.to_sym]
+      end
+    end
+
+    def total_count
+      @total_count ||= begin
+        get(page_size: 1).body[:total_count]
+      end
+    end
+
+    alias :length :total_count
+
+    def each
+      return to_enum(__callee__) unless block_given?
+
+      0.step.each do |index|
+        item = self[index] or break
+        yield item
+      end
+    end
+
+    private
+
+    attr_reader :client
+
+    def get(page: 1, page_size: @page_size)
+      client.get(resource_url, params.merge(page: page, page_size: page_size))
+    end
+
+    def map(collection)
+      Array(collection).map{ |row| type.new(row) }
+    end
+  end
+end

data/lib/payable/types.rb

@@ -0,0 +1,11 @@
+require 'dry/types'
+
+module Payable
+  module Types
+    include Dry::Types.module
+
+    QuantityMeasure = Strict::String.enum('time', 'money', 'unit', 'distance')
+    InviteStatus    = Strict::String.enum('invited', 'not_invited', 'accepted')
+    PaymentStatus   = Strict::String.enum('draft_ready', 'payment_pending', 'payment_failed', 'payment_refunded', 'paid')
+  end
+end

data/lib/payable/version.rb

@@ -0,0 +1,3 @@
+module Payable
+  VERSION = "0.1.0"
+end

data/lib/payable/work.rb

@@ -0,0 +1,17 @@
+module Payable
+  class Work < Resource
+    attribute :worker_id, Types::Strict::Int
+    attribute :work_type_id, Types::Strict::Int
+    attribute :quantity, Types::Coercible::Decimal
+    attribute :quantity_measure, Types::QuantityMeasure
+    attribute :start, Types::Form::DateTime
+    attribute :end, Types::Form::DateTime
+    attribute :note, Types::String
+    attribute :payment_id, Types::Strict::Int
+    attribute :payment_status, Types::PaymentStatus
+
+    def self.collection; 'work'; end
+
+    extend Writeable
+  end
+end

data/lib/payable/work_type.rb

@@ -0,0 +1,8 @@
+require 'payable/resource'
+
+module Payable
+  class WorkType < Resource
+    attribute :name, Types::String
+    attribute :quantity_measure, Types::QuantityMeasure
+  end
+end

data/lib/payable/worker.rb

@@ -0,0 +1,17 @@
+module Payable
+  class Worker < Resource
+    attribute :display_name, Types::String
+    attribute :first_name, Types::String
+    attribute :last_name, Types::String
+    attribute :email, Types::String
+    attribute :signed_up, Types::Bool
+    attribute :invite_status, Types::InviteStatus
+    attribute :payable, Types::Bool
+
+    extend Writeable
+    def self.create(params = {})
+      raise InvalidRequest, "display_name is a required parameter" unless params[:display_name]
+      super
+    end
+  end
+end

data/lib/payable/writeable.rb

@@ -0,0 +1,10 @@
+module Payable
+  module Writeable
+    def create(params = {})
+      client = params.delete(:client){ Payable.client }
+      new client.post(api_url.join(collection), params).body
+    rescue Faraday::ClientError => e
+      raise InvalidRequest.new(e.response), e.message
+    end
+  end
+end

data/payable-api.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'payable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "payable-api"
+  spec.version       = Payable::VERSION
+  spec.authors       = ["Adam Lassek"]
+  spec.email         = ["adam@doubleprime.net"]
+
+  spec.summary       = %q{A simple API client for Payable.com}
+  spec.homepage      = "https://github.com/alassek/payable-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "dry-configurable"
+  spec.add_dependency "dry-types"
+  spec.add_dependency "dry-struct"
+  spec.add_dependency "addressable"
+
+  spec.add_development_dependency "bundler", ">= 1.7.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "vcr", "~> 3.0"
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: payable-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Lassek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- adam@doubleprime.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/payable.rb
+- lib/payable/client.rb
+- lib/payable/middleware.rb
+- lib/payable/payment.rb
+- lib/payable/resource.rb
+- lib/payable/resource_list.rb
+- lib/payable/types.rb
+- lib/payable/version.rb
+- lib/payable/work.rb
+- lib/payable/work_type.rb
+- lib/payable/worker.rb
+- lib/payable/writeable.rb
+- payable-api.gemspec
+homepage: https://github.com/alassek/payable-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A simple API client for Payable.com
+test_files: []