ribbon-flow 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0acb27cf945e51d9babe8e9b0c2b8a9ee79377ae
-  data.tar.gz: 3d5ca2b56cc3e536e06e7198fe4c47495cd330b9
+  metadata.gz: 44ba94d1d8e135b478e29ef77866a1dc8413d333
+  data.tar.gz: bd3c21b4efc1cb6c2b3f3f72dba1eaa9113ab952
 SHA512:
-  metadata.gz: 3ef82e5b73b6d6f7e48ed645b125397a98fabe5433ca992a7ff40b59478baeebb072df48712228a9adc8f27398507ac91ecdfebd5b04675291037cfefea5fa0c
-  data.tar.gz: db8b304d1973f08ff90fe76792b7f4ac15d5856f31649c2a78b45b405ab94beb30d586646bdbe6f7718482cc282c118b10ed1e170e78beadd6eafd1efdd05559
+  metadata.gz: 8feeaa2cbfb64d1e286bb21f9e8d08395c266942bfb54096181ee9d465b5d197fd447134b59f06a4755699e37fe35b897e82ee860f18fbf19042439efc0363a9
+  data.tar.gz: 39fcdf01e5e00df76c624a450148803b30371699693e92ed93c851978395485dbe74cf8521495e3406bec83029255a1cc0214a180e94aed0884878527e254b88

data/lib/flow.rb

@@ -13,9 +13,31 @@ module Flow
   end
 
   def self.connection
-    @__connection_cache ||= Flow::Connection.new(config.api_key, config.url)
+    @__connection_cache ||= Flow::Connection.new(api_key, url)
   end
 
+  ##################################################
+  # Config helpers
+  ##################################################
+  def self.url
+    config.url
+  end
+
+  def self.url=(url)
+    config.url = url
+  end
+
+  def self.api_key
+    config.api_key
+  end
+
+  def self.api_key=(api_key)
+    config.api_key = api_key
+  end
+
+  ##################################################
+  # Load helpers
+  ##################################################
   def self.pool(pool_token)
     Flow::Models::Pool.load(connection, pool_token)
   end

data/lib/flow/config.rb

@@ -27,6 +27,7 @@ module Flow
     end
 
     def url=(url)
+      raise Flow::Errors::ConfigError, "URL must be defined" unless url
       url = url[0..-2] if url[-1] == '/' # No trailing forward-slash
       _set(:url, url)
     end
@@ -40,7 +41,7 @@ module Flow
     def _set(key, value)
       # Changing the config value should require calling the
       # _set method again.
-      return @config[key.to_sym] = value.dup.freeze
+      return @config[key.to_sym] = value.nil? ? nil : value.dup.freeze
     end
 
     def _get(key)

data/lib/flow/connection.rb

@@ -15,11 +15,15 @@ module Flow
     attr_reader :port
 
     def initialize(api_key, url='https://flow.ribbon.co', version=1)
+      raise Flow::Errors::ConnectionError, "API Key must be defined." unless api_key
+      raise Flow::Errors::ConnectionError, "URL must be defined." unless url
+      raise Flow::Errors::ConnectionError, "Version must be defined." unless version
+
       @version = version
 
       @url = (url[-1] == '/' ? url[0..-2] : url).dup.freeze # Remove trailing slash.
-
-      if /^([A-Za-z0-9]{20})\.([A-Za-z0-9]{43})$/.match(api_key)
+      
+      if /^([A-Za-z0-9]{20})\.([A-Za-z0-9]{43})$/.match(api_key.to_s)
         @access_key = $1.dup.freeze
         @signing_key = $2.dup.freeze
       else

data/lib/flow/errors.rb

@@ -7,6 +7,8 @@ module Flow
     class ConnectionError < FlowError; end
     class ResponseError < FlowError; end
     class LoadError < FlowError; end
+    class BuildError < FlowError; end
+    class ConfigError < FlowError; end
 
   end
 end

data/lib/flow/models.rb

@@ -1,4 +1,5 @@
 require 'flow/models/model'
 require 'flow/models/pool'
 require 'flow/models/card'
-require 'flow/models/transaction'
+require 'flow/models/transaction'
+require 'flow/models/credit'

data/lib/flow/models/card.rb

@@ -2,14 +2,6 @@ module Flow
   module Models
     class Card < Model
 
-      def self.load(connection, card_token)
-        r = connection.get("cards/#{card_token}")
-
-        raise Flow::Errors::LoadError.new(r.message) unless r.success?
-
-        return r.card
-      end
-
       def ready?
         self.status == 'ready'
       end
@@ -30,7 +22,7 @@ module Flow
         end
 
         raise Flow::Errors::ResponseError.new(r.message) unless r.success?
-
+        
         r.transaction
       end
 

data/lib/flow/models/credit.rb

@@ -0,0 +1,27 @@
+module Flow
+  module Models
+    class Credit < Transaction
+
+      def pending?
+        self.status == 'pending'
+      end
+
+      def scheduled?
+        self.status == 'scheduled'
+      end
+
+      def cleared?
+        self.status == 'cleared'
+      end
+
+      def failed?
+        self.status == 'failed'
+      end
+
+      def error?
+        self.status == 'error'
+      end
+      
+    end
+  end
+end

data/lib/flow/models/model.rb

@@ -11,6 +11,16 @@ module Flow
         @model_hash = model_hash
       end
 
+      def reload
+        self.class.load(connection, self.token)
+      end
+
+      def reload!
+        updated_version = self.reload
+        @model_hash = updated_version.model_hash
+        self
+      end
+
       def method_missing(meth, *args, &block)
         if model_hash.key?(meth.to_s)
           return Model.load_model(meth, connection, model_hash[meth.to_s])
@@ -19,22 +29,52 @@ module Flow
         super
       end
 
-      def self.load_model(name, connection, model_hash)
-        name = name.to_sym
-
-        case name
-        when :pool
-          return Flow::Models::Pool.new(connection, model_hash)
-        when :card
-          return Flow::Models::Card.new(connection, model_hash)
-        when :transaction
-          return Flow::Models::Transaction.new(connection, model_hash)
-        else
-          return model_hash
+      ############################################################
+      # Class methods
+      ############################################################
+      class << self
+        def __load_path
+          # Really wish I had Rail's pluralize here, but this
+          # fits all of our cases for now and should fit most
+          # if not all of our cases going forward.
+          "#{__model_name}s"
+        end
+
+        def __model_name
+          model_name = self.name.split('::').last.downcase
+          raise "should not call this for abstract model" if model_name == 'model'
+          model_name
         end
-      end
 
-    end
+        def build(connection, model_hash)
+          # Default behavior is just to create an instance
+          # of the class.
+          self.new(connection, model_hash)
+        end
+
+        def load(connection, token)
+          r = connection.get("#{__load_path}/#{token}")
+          raise Flow::Errors::LoadError.new(r.message) unless r.success?
+
+          return r.send(__model_name)
+        end
+
+        def load_model(name, connection, model_hash)
+          name = name.to_sym
+
+          case name
+          when :pool
+            return Flow::Models::Pool.build(connection, model_hash)
+          when :card
+            return Flow::Models::Card.build(connection, model_hash)
+          when :transaction
+            return Flow::Models::Transaction.build(connection, model_hash)
+          else
+            return model_hash
+          end
+        end
+      end # class << self
 
-  end
-end
+    end # Model
+  end # Models
+end # Flow

data/lib/flow/models/pool.rb

@@ -2,12 +2,12 @@ module Flow
   module Models
     class Pool < Model
       
-      def self.load(connection, pool_token)
-        r = connection.get("pools/#{pool_token}")
-
-        raise Flow::Errors::LoadError.new(r.message) unless r.success?
-
-        return r.pool
+      def test?
+        self.type == 'test'
+      end
+      
+      def production?
+        self.type == 'production'
       end
 
     end

data/lib/flow/models/transaction.rb

@@ -2,34 +2,26 @@ module Flow
   module Models
     class Transaction < Model
 
-      def self.load(connection, tx_token)
-        r = connection.get("transactions/#{tx_token}")
-
-        raise Flow::Errors::LoadError.new(r.message) unless r.success?
-
-        return r.transaction
-      end
-
-      def pending?
-        self.status == 'pending'
+      def self.build(connection, model_hash)
+        case model_hash['type'].to_sym
+        when :credit
+          return Credit.new(connection, model_hash)
+        else
+          raise Flow::Errors::BuildError.new("Invalid Transaction type: #{model_hash['type']}.")
+        end
       end
 
-      def scheduled?
-        self.status == 'scheduled'
+      # Override inherited behavior.
+      # This causes subclasses of transactions to continue
+      # to be treated as transactions at the API level.
+      def self.__model_name
+        'transaction'
       end
 
-      def cleared?
-        self.status == 'cleared'
+      def credit?
+        self.type == 'credit'
       end
 
-      def failed?
-        self.status == 'failed'
-      end
-
-      def error?
-        self.status == 'error'
-      end
-      
     end
   end
 end

data/lib/flow/version.rb

@@ -1,4 +1,4 @@
 
 module Flow
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ribbon-flow
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Robert Honer
@@ -30,7 +30,7 @@ cert_chain:
   grVI0T63q4/t9yjlCPkbK1VTObseWNPA2/7twecdkCVN3VaWEml4xf2KiOwnKDfk
   aZOXvndbbL+k3uaxs/Fpfsi0AD02HiceGjSOZFd9Wyk=
   -----END CERTIFICATE-----
-date: 2014-06-09 00:00:00.000000000 Z
+date: 2014-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -58,6 +58,7 @@ files:
 - lib/flow/connection.rb
 - lib/flow/errors.rb
 - lib/flow/models/card.rb
+- lib/flow/models/credit.rb
 - lib/flow/models/model.rb
 - lib/flow/models/pool.rb
 - lib/flow/models/transaction.rb