rubill 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9b71f0d60dd41ff424f2e915cb7ed2def75c2c1
+  data.tar.gz: 51aef8f5bed4e369786e51d655e9afa65ab7ea2e
+SHA512:
+  metadata.gz: 8f57a53a8388bbea6fd2b515bef3c30dd4e7a0675dfc3828ed541fe1aa162e4b7ce1eec365e28acf8105e672da1f5fb7de05bb2833df5633de84b81c9fc7fc6a
+  data.tar.gz: eb04ddf63780996914870264f0bf58a420abe1d1e88abf911684ff956aa1ecf7bbc39d03fd9866d49bb48f3cbaf8819aad7c49a00631f7d8130a1bd740e3d652

data/lib/rubill/base.rb

@@ -0,0 +1,90 @@
+module Rubill
+  class Base
+    attr_accessor :remote_record
+
+    class NotFound < StandardError; end
+
+    def initialize(remote)
+      self.remote_record = remote
+    end
+
+    def [](key)
+      remote_record.send(:[], key)
+    end
+
+    def []=(key, value)
+      remote_record.send(:[]=, key, value)
+    end
+
+    def self.active
+      where([Query::Filter.new("isActive", "=", "1")])
+    end
+
+    def id
+      remote_record[:id]
+    end
+
+    def save
+      self.class.update(remote_record)
+    end
+
+    def delete
+      self.class.delete(id)
+    end
+
+    def self.find(id)
+      new(Query.read(remote_class_name, id))
+    end
+
+    def self.create(data)
+      new(Query.create(remote_class_name, data.merge({entity: remote_class_name})))
+    end
+
+    def self.update(data)
+      Query.update(remote_class_name, data.merge({entity: remote_class_name}))
+    end
+
+    def self.delete(id)
+      Query.delete(remote_class_name, id)
+    end
+
+    def self.where(filters=[])
+      raise ArgumentError unless filters.is_a?(Enumerable)
+      raise ArgumentError if !filters.is_a?(Hash) && !filters.all? { |f| f.is_a?(Query::Filter) }
+
+      if filters.is_a?(Hash)
+        filters = filters.map do |field, value|
+          Query::Filter.new(field.to_s, "=", value)
+        end
+      end
+
+      result = []
+      start = 0
+      step = 999
+      loop do
+        chunk = Query.list(remote_class_name, start, step, filters)
+
+        if !chunk.empty?
+          records = chunk.map { |r| new(r) }
+          result += records
+          start += step
+        end
+
+        break if chunk.length < step
+      end
+
+      result
+    end
+
+    def self.all
+      # Note: this method returns ALL of desired entity, including inactive
+      where([])
+    end
+
+    private
+
+    def self.remote_class_name
+      raise NotImplementedError
+    end
+  end
+end

data/lib/rubill/bill.rb

@@ -0,0 +1,11 @@
+module Rubill
+  class Bill < Base
+    def self.send_payment(opts)
+      SentPayment.create(opts)
+    end
+
+    def self.remote_class_name
+      "Bill"
+    end
+  end
+end

data/lib/rubill/customer.rb

@@ -0,0 +1,15 @@
+module Rubill
+  class Customer < Base
+    def self.find_by_name(name)
+      where([Query::Filter.new("name", "=", name)]).first
+    end
+
+    def contacts
+      CustomerContact.active_by_customer(id)
+    end
+
+    def self.remote_class_name
+      "Customer"
+    end
+  end
+end

data/lib/rubill/customer_contact.rb

@@ -0,0 +1,20 @@
+module Rubill
+  class CustomerContact < Base
+    def self.find_by_customer(customer_id)
+      where([Query::Filter.new("customerId", "=", customer_id)])
+    end
+
+    def self.active_by_customer(customer_id)
+      where(
+        [
+          Query::Filter.new("customerId", "=", customer_id),
+          Query::Filter.new("isActive", "=", "1"),
+        ]
+      )
+    end
+
+    def self.remote_class_name
+      "CustomerContact"
+    end
+  end
+end

data/lib/rubill/invoice.rb

@@ -0,0 +1,46 @@
+module Rubill
+  class Invoice < Base
+    def amount_paid
+      amount - amount_due
+    end
+
+    def amount
+      remote_record[:amount]
+    end
+
+    def send_email(subject, body, contact_emails)
+      Query.execute(
+        "/SendInvoice.json",
+        {
+          invoiceId: id,
+          headers: {
+            subject: subject,
+            toEmailAddresses: contact_emails
+          },
+          content: {
+            body: body
+          }
+        }
+      )
+    end
+
+    def amount_due
+      remote_record[:amountDue]
+    end
+
+    def self.line_item(amount, description, item_id)
+      {
+        entity: "InvoiceLineItem",
+        quantity: 1,
+        itemId: item_id,
+        # must to_f amount otherwise decimal will be converted to string in JSON
+        price: amount.to_f,
+        description: description,
+      }
+    end
+
+    def self.remote_class_name
+      "Invoice"
+    end
+  end
+end

data/lib/rubill/query.rb

@@ -0,0 +1,86 @@
+module Rubill
+  class Query
+    attr_accessor :url
+    attr_accessor :options
+
+    def initialize(url, opts={})
+      self.url = url
+      self.options = opts
+    end
+
+    def self.list(entity, start=0, step=999, filters=[])
+      execute(
+          "/List/#{entity}.json",
+          start: start,
+          max: step,
+          filters: filters.map(&:to_hash),
+       )
+    end
+
+    def self.read(entity, id)
+      execute("/Crud/Read/#{entity}.json", id: id)
+    end
+
+    def self.create(entity, object={})
+      execute("/Crud/Create/#{entity}.json", obj: object)
+    end
+
+    def self.update(entity, object={})
+      execute("/Crud/Update/#{entity}.json", obj: object)
+    end
+
+    def self.delete(entity, id)
+      execute("/Crud/Delete/#{entity}.json", id: id)
+    end
+
+    def self.pay_bills(opts={})
+      execute("/PayBills.json", opts)
+    end
+
+    def self.receive_payment(opts={})
+      execute("/RecordARPayment.json", opts)
+    end
+
+    def self.send_payment(opts={})
+      execute("/RecordAPPayment.json", opts)
+    end
+
+    def self.upload_attachment(opts={})
+      execute("/UploadAttachment.json", opts)
+    end
+
+    def self.void_sent_payment(id)
+      execute("/VoidAPPayment.json", sentPayId: id)
+    end
+
+    def self.void_received_payment(id)
+      execute("/VoidARPayment.json", id: id)
+    end
+
+    def execute
+      Session.instance.execute(self)
+    end
+
+    def self.execute(url, options)
+      new(url, options).execute
+    end
+
+    class Filter
+      attr_accessor :field
+      attr_accessor :op
+      attr_accessor :value
+
+      def initialize(field, op, value)
+        self.field, self.op, self.value = field, op, value
+      end
+
+      def to_hash
+        {
+          field: field,
+          op: op,
+          value: value,
+        }
+      end
+    end
+  end
+end

data/lib/rubill/received_payment.rb

@@ -0,0 +1,32 @@
+module Rubill
+  class ReceivedPayment < Base
+    def self.create(opts)
+      Query.receive_payment(opts)
+    end
+
+    def self.active
+      where([Query::Filter.new("status", "!=", "1")])
+    end
+
+    def void
+      delete
+    end
+
+    def delete
+      self.class.delete(id)
+    end
+
+    def self.delete(id)
+      # To overwrite delete method in superclass
+      void(id)
+    end
+
+    def self.void(id)
+      Query.void_received_payment(id)
+    end
+
+    def self.remote_class_name
+      "ReceivedPay"
+    end
+  end
+end

data/lib/rubill/sent_payment.rb

@@ -0,0 +1,32 @@
+module Rubill
+  class SentPayment < Base
+    def self.create(opts)
+      Query.send_payment(opts)
+    end
+
+    def self.active
+      where([Query::Filter.new("status", "!=", "4")])
+    end
+
+    def void
+      delete
+    end
+
+    def delete
+      self.class.delete(id)
+    end
+
+    def self.delete(id)
+      # To overwrite delete method in superclass
+      void(id)
+    end
+
+    def self.void(id)
+      Query.void_sent_payment(id)
+    end
+
+    def self.remote_class_name
+      "SentPay"
+    end
+  end
+end

data/lib/rubill/session.rb

@@ -0,0 +1,103 @@
+require "httmultiparty"
+require "json"
+require "singleton"
+
+module Rubill
+  class APIError < StandardError; end
+
+  class Session
+    include HTTParty
+    include Singleton
+
+    attr_accessor :id
+
+    base_uri "https://api.bill.com/api/v2"
+
+    def initialize
+      config = self.class.configuration
+      if missing = (!config.missing_keys.empty? && config.missing_keys)
+        raise "Missing key(s) in configuration: #{missing}"
+      end
+
+      if config.sandbox
+        self.class.base_uri "https://api-stage.bill.com/api/v2"
+      end
+
+      login
+    end
+
+    def execute(query)
+      _post(query.url, query.options)
+    end
+
+    def login
+      self.id = self.class.login
+    end
+
+    def self.login
+      login_options = {
+        password: configuration.password,
+        userName: configuration.user_name,
+        devKey: configuration.dev_key,
+        orgId: configuration.org_id,
+      }
+      login = _post("/Login.json", login_options)
+      login[:sessionId]
+    end
+
+    def options(data={})
+      {
+        sessionId: id,
+        devKey: self.class.configuration.dev_key,
+        data: data.to_json,
+      }
+    end
+
+    def self.default_headers
+      {"Content-Type" => "application/x-www-form-urlencoded"}
+    end
+
+    def _post(url, data, retries=0)
+      begin
+        self.class._post(url, options(data))
+      rescue APIError => e
+        if e.message =~ /Session is invalid/ && retries < 3
+          login
+          _post(url, data, retries + 1)
+        else
+          raise
+        end
+      end
+    end
+
+    def self._post(url, options)
+      if options.key?(:fileName)
+        file = StringIO.new(options.delete(:content))
+      end
+
+      post_options = {
+        body: options,
+        headers: default_headers,
+      }
+
+      post_options[:file] = file if file
+
+      if self.configuration.debug
+        post_options[:debug_output] = $stdout
+      end
+
+      response = post(url, post_options)
+      result = JSON.parse(response.body, symbolize_names: true)
+
+      unless result[:response_status] == 0
+        raise APIError.new(result[:response_data][:error_message])
+      end
+
+      result[:response_data]
+    end
+
+    def self.configuration
+      Rubill::configuration
+    end
+  end
+end

data/lib/rubill/vendor.rb

@@ -0,0 +1,14 @@
+module Rubill
+  class Vendor < Base
+    def self.remote_class_name
+      "Vendor"
+    end
+
+    def bills
+      Bill.where([
+        Query::Filter.new("isActive", "=", "1"),
+        Query::Filter.new("vendorId", "=", id),
+      ])
+    end
+  end
+end

data/lib/rubill.rb

@@ -0,0 +1,58 @@
+module Rubill
+  attr_writer :configuration
+
+  def self.configure(&block)
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :user_name
+    attr_accessor :password
+    attr_accessor :dev_key
+    attr_accessor :org_id
+    attr_writer :debug
+    attr_writer :sandbox
+
+    def required_keys
+      %w(user_name password dev_key org_id)
+    end
+
+    def to_hash
+      required_keys.each_with_object({}) do |k, h|
+        h[k] = send(k.to_sym)
+      end
+    end
+
+    def missing_keys
+      required_keys.reject do |k|
+        to_hash[k]
+      end
+    end
+
+    def debug
+      @debug || false
+    end
+
+    def sandbox
+      @sandbox || false
+    end
+  end
+end
+
+require "rubill/session"
+require "rubill/query"
+require "rubill/base"
+require "rubill/bill"
+require "rubill/bill_payment"
+require "rubill/invoice"
+require "rubill/attachment"
+require "rubill/sent_payment"
+require "rubill/sent_bill_payment"
+require "rubill/received_payment"
+require "rubill/vendor"
+require "rubill/customer"
+require "rubill/customer_contact"

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: rubill
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Andrew Taber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  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: json
+  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: rspec
+  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: 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'
+description: A Ruby interface to Bill.com's API
+email: andrew.e.taber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rubill.rb
+- lib/rubill/base.rb
+- lib/rubill/bill.rb
+- lib/rubill/customer.rb
+- lib/rubill/customer_contact.rb
+- lib/rubill/invoice.rb
+- lib/rubill/query.rb
+- lib/rubill/received_payment.rb
+- lib/rubill/sent_payment.rb
+- lib/rubill/session.rb
+- lib/rubill/vendor.rb
+homepage: http://rubygems.org/gems/rubill
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Interface with Bill.com
+test_files: []