octobat 0.0.2

data/lib/octobat/credit_note_numbering_sequence.rb

@@ -0,0 +1,5 @@
+module Octobat
+  class CreditNoteNumberingSequence < APIResource
+    include Octobat::APIOperations::List
+  end
+end

data/lib/octobat/customer.rb

@@ -0,0 +1,7 @@
+module Octobat
+  class Customer < APIResource
+    include Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+  end
+end

data/lib/octobat/errors/api_connection_error.rb

@@ -0,0 +1,4 @@
+module Octobat
+  class APIConnectionError < OctobatError
+  end
+end

data/lib/octobat/errors/api_error.rb

@@ -0,0 +1,4 @@
+module Octobat
+  class APIError < OctobatError
+  end
+end

data/lib/octobat/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Octobat
+  class AuthenticationError < OctobatError
+  end
+end

data/lib/octobat/errors/invalid_request_error.rb

@@ -0,0 +1,10 @@
+module Octobat
+  class InvalidRequestError < OctobatError
+    attr_accessor :param
+
+    def initialize(message, param, http_status=nil, http_body=nil, json_body=nil)
+      super(message, http_status, http_body, json_body)
+      @param = param
+    end
+  end
+end

data/lib/octobat/errors/octobat_error.rb

@@ -0,0 +1,20 @@
+module Octobat
+  class OctobatError < StandardError
+    attr_reader :message
+    attr_reader :http_status
+    attr_reader :http_body
+    attr_reader :json_body
+
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+    end
+
+    def to_s
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/octobat/invoice.rb

@@ -0,0 +1,17 @@
+module Octobat
+  class Invoice < APIResource
+    include Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+
+    def pay(payment_data)
+      response, api_key = Octobat.request(:patch, pay_url, @api_key, {payment: payment_data})
+      refresh_from(response, api_key)
+    end
+
+    private
+
+    def pay_url
+      url + '/pay'
+    end
+  end
+end

data/lib/octobat/invoice_item.rb

@@ -0,0 +1,4 @@
+module Octobat
+  class InvoiceItem < APIResource
+  end
+end

data/lib/octobat/list_object.rb

@@ -0,0 +1,37 @@
+module Octobat
+  class ListObject < OctobatObject
+
+    def [](k)
+      case k
+      when String, Symbol
+        super
+      else
+        raise ArgumentError.new("You tried to access the #{k.inspect} index, but ListObject types only support Octobat keys. (HINT: List calls return an object with a 'data' (which is the data array). You likely want to call #data[#{k.inspect}])")
+      end
+    end
+
+    def each(&blk)
+      self.data.each(&blk)
+    end
+
+    def retrieve(id, api_key=nil)
+      api_key ||= @api_key
+      response, api_key = Octobat.request(:get,"#{url}/#{CGI.escape(id)}", api_key)
+      Util.convert_to_octobat_object(response, api_key)
+    end
+
+    def create(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      api_key ||= @api_key
+      response, api_key = Octobat.request(:post, url, api_key, params, headers)
+      Util.convert_to_octobat_object(response, api_key)
+    end
+
+    def all(params={}, opts={})
+      api_key, headers = Util.parse_opts(opts)
+      api_key ||= @api_key
+      response, api_key = Octobat.request(:get, url, api_key, params, headers)
+      Util.convert_to_octobat_object(response, api_key)
+    end
+  end
+end

data/lib/octobat/numbering_sequence.rb

@@ -0,0 +1,5 @@
+module Octobat
+  class NumberingSequence < APIResource
+    include Octobat::APIOperations::List
+  end
+end

data/lib/octobat/octobat_object.rb

@@ -0,0 +1,190 @@
+module Octobat
+  class OctobatObject
+    include Enumerable
+
+    attr_accessor :api_key
+    @@permanent_attributes = Set.new([:api_key, :id])
+
+    # The default :id method is deprecated and isn't useful to us
+    if method_defined?(:id)
+      undef :id
+    end
+
+    def initialize(id=nil, api_key=nil)
+      # parameter overloading!
+      if id.kind_of?(Hash)
+        @retrieve_options = id.dup
+        @retrieve_options.delete(:id)
+        id = id[:id]
+      else
+        @retrieve_options = {}
+      end
+
+      @api_key = api_key
+      @values = {}
+      # This really belongs in APIResource, but not putting it there allows us
+      # to have a unified inspect method
+      @unsaved_values = Set.new
+      @transient_values = Set.new
+      @values[:id] = id if id
+    end
+
+    def self.construct_from(values, api_key=nil)
+      self.new(values[:id], api_key).refresh_from(values, api_key)
+    end
+
+    def to_s(*args)
+      JSON.pretty_generate(@values)
+    end
+
+    def inspect
+      id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + JSON.pretty_generate(@values)
+    end
+
+    def refresh_from(values, api_key, partial=false)
+      @api_key = api_key
+
+      @previous_metadata = values[:metadata]
+      removed = partial ? Set.new : Set.new(@values.keys - values.keys)
+      added = Set.new(values.keys - @values.keys)
+      # Wipe old state before setting new.  This is useful for e.g. updating a
+      # customer, where there is no persistent card parameter.  Mark those values
+      # which don't persist as transient
+
+      instance_eval do
+        remove_accessors(removed)
+        add_accessors(added)
+      end
+      removed.each do |k|
+        @values.delete(k)
+        @transient_values.add(k)
+        @unsaved_values.delete(k)
+      end
+      values.each do |k, v|
+        @values[k] = Util.convert_to_octobat_object(v, api_key)
+        @transient_values.delete(k)
+        @unsaved_values.delete(k)
+      end
+
+      return self
+    end
+
+    def [](k)
+      @values[k.to_sym]
+    end
+
+    def []=(k, v)
+      send(:"#{k}=", v)
+    end
+
+    def keys
+      @values.keys
+    end
+
+    def values
+      @values.values
+    end
+
+    def to_json(*a)
+      JSON.generate(@values)
+    end
+
+    def as_json(*a)
+      @values.as_json(*a)
+    end
+
+    def to_hash
+      @values.inject({}) do |acc, (key, value)|
+        acc[key] = value.respond_to?(:to_hash) ? value.to_hash : value
+        acc
+      end
+    end
+
+    def each(&blk)
+      @values.each(&blk)
+    end
+
+    def _dump(level)
+      Marshal.dump([@values, @api_key])
+    end
+
+    def self._load(args)
+      values, api_key = Marshal.load(args)
+      construct_from(values, api_key)
+    end
+
+    if RUBY_VERSION < '1.9.2'
+      def respond_to?(symbol)
+        @values.has_key?(symbol) || super
+      end
+    end
+
+    protected
+
+    def metaclass
+      class << self; self; end
+    end
+
+    def remove_accessors(keys)
+      metaclass.instance_eval do
+        keys.each do |k|
+          next if @@permanent_attributes.include?(k)
+          k_eq = :"#{k}="
+          remove_method(k) if method_defined?(k)
+          remove_method(k_eq) if method_defined?(k_eq)
+        end
+      end
+    end
+
+    def add_accessors(keys)
+      metaclass.instance_eval do
+        keys.each do |k|
+          next if @@permanent_attributes.include?(k)
+          k_eq = :"#{k}="
+          define_method(k) { @values[k] }
+          define_method(k_eq) do |v|
+            if v == ""
+              raise ArgumentError.new(
+                "You cannot set #{k} to an empty string." \
+                "We interpret empty strings as nil in requests." \
+                "You may set #{self}.#{k} = nil to delete the property.")
+            end
+            @values[k] = v
+            @unsaved_values.add(k)
+          end
+        end
+      end
+    end
+
+    def method_missing(name, *args)
+      # TODO: only allow setting in updateable classes.
+      if name.to_s.end_with?('=')
+        attr = name.to_s[0...-1].to_sym
+        add_accessors([attr])
+        begin
+          mth = method(name)
+        rescue NameError
+          raise NoMethodError.new("Cannot set #{attr} on this object. HINT: you can't set: #{@@permanent_attributes.to_a.join(', ')}")
+        end
+        return mth.call(args[0])
+      else
+        return @values[name] if @values.has_key?(name)
+      end
+
+      begin
+        super
+      rescue NoMethodError => e
+        if @transient_values.include?(name)
+          raise NoMethodError.new(e.message + ".  HINT: The '#{name}' attribute was set in the past, however. It was then wiped when refreshing the object with the result returned by Octobat's API, probably as a result of a save().  The attributes currently available on this object are: #{@values.keys.join(', ')}")
+        else
+          raise
+        end
+      end
+    end
+
+    def respond_to_missing?(symbol, include_private = false)
+      @values && @values.has_key?(symbol) || super
+    end
+  end
+end

data/lib/octobat/payment.rb

@@ -0,0 +1,4 @@
+module Octobat
+  class Payment < APIResource
+  end
+end

data/lib/octobat/payment_mode.rb

@@ -0,0 +1,7 @@
+module Octobat
+  class PaymentMode < APIResource
+    include Octobat::APIOperations::List
+    include Octobat::APIOperations::Create
+    include Octobat::APIOperations::Update
+  end
+end

data/lib/octobat/singleton_api_resource.rb

@@ -0,0 +1,20 @@
+module Octobat
+  class SingletonAPIResource < APIResource
+    def self.url
+      if self == SingletonAPIResource
+        raise NotImplementedError.new('SingletonAPIResource is an abstract class.  You should perform actions on its subclasses (Account, etc.)')
+      end
+      "/v1/#{CGI.escape(class_name.downcase)}"
+    end
+
+    def url
+      self.class.url
+    end
+
+    def self.retrieve(api_key=nil)
+      instance = self.new(nil, api_key)
+      instance.refresh
+      instance
+    end
+  end
+end

data/lib/octobat/util.rb

@@ -0,0 +1,144 @@
+module Octobat
+  module Util
+    def self.expand_nested_objects(h)
+      case h
+      when Hash
+        res = {}
+        h.each { |k, v| res[k] = expand_nested_objects(v) unless v.nil? }
+        res
+      when Array
+        res = {'' => h.map{|v| expand_nested_objects(v)}}
+        res
+      else
+        h
+      end
+    end
+    
+    def self.objects_to_ids(h)
+      case h
+      when APIResource
+        h.id
+      when Hash
+        res = {}
+        h.each { |k, v| res[k] = objects_to_ids(v) unless v.nil? }
+        res
+      when Array
+        h.map { |v| objects_to_ids(v) }
+      else
+        h
+      end
+    end
+
+    def self.object_classes
+      @object_classes ||= {
+        # data structures
+        'list' => ListObject,
+
+        # business objects
+        'payment_mode' => PaymentMode,
+        'payment' => Payment,
+        'numbering_sequence' => NumberingSequence,
+        'credit_note_numbering_sequence' => CreditNoteNumberingSequence,
+        'invoice' => Invoice,
+        'invoice_item' => InvoiceItem,
+        'customer' => Customer
+      }
+    end
+
+    def self.convert_to_octobat_object(resp, api_key)
+      case resp
+      when Array
+        resp.map { |i| convert_to_octobat_object(i, api_key) }
+      when Hash
+        # Try converting to a known object class.  If none available, fall back to generic OctobatObject
+        object_classes.fetch(resp[:object], OctobatObject).construct_from(resp, api_key)
+      else
+        resp
+      end
+    end
+
+    def self.file_readable(file)
+      # This is nominally equivalent to File.readable?, but that can
+      # report incorrect results on some more oddball filesystems
+      # (such as AFS)
+      begin
+        File.open(file) { |f| }
+      rescue
+        false
+      else
+        true
+      end
+    end
+
+    def self.symbolize_names(object)
+      case object
+      when Hash
+        new_hash = {}
+        object.each do |key, value|
+          key = (key.to_sym rescue key) || key
+          new_hash[key] = symbolize_names(value)
+        end
+        new_hash
+      when Array
+        object.map { |value| symbolize_names(value) }
+      else
+        object
+      end
+    end
+
+    def self.url_encode(key)
+      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+    def self.flatten_params(params, parent_key=nil)
+      result = []
+      params.each do |key, value|
+        calculated_key = parent_key ? "#{parent_key}[#{url_encode(key)}]" : url_encode(key)
+        if value.is_a?(Hash)
+          result += flatten_params(value, calculated_key)
+        elsif value.is_a?(Array)
+          result += flatten_params_array(value, calculated_key)
+        else
+          result << [calculated_key, value]
+        end
+      end
+      result
+    end
+
+    def self.flatten_params_array(value, calculated_key)
+      result = []
+      value.each do |elem|
+        if elem.is_a?(Hash)
+          result += flatten_params(elem, calculated_key)
+        elsif elem.is_a?(Array)
+          result += flatten_params_array(elem, calculated_key)
+        else
+          result << ["#{calculated_key}[]", elem]
+        end
+      end
+      result
+    end
+
+    # The secondary opts argument can either be a string or hash
+    # Turn this value into an api_key and a set of headers
+    def self.parse_opts(opts)
+      case opts
+      when NilClass
+        return nil, {}
+      when String
+        return opts, {}
+      when Hash
+        headers = {}
+        if opts[:idempotency_key]
+          headers[:idempotency_key] = opts[:idempotency_key]
+        end
+        if opts[:octobat_account]
+          headers[:octobat_account] = opts[:octobat_account]
+        end
+        return opts[:api_key], headers
+      else
+        raise TypeError.new("parse_opts expects a string or a hash")
+      end
+    end
+  end
+end