spigot 0.2.2 → 0.3.0

data/lib/spigot/map/definition.rb

@@ -1,16 +1,15 @@
 module Spigot
   module Map
     class Definition
-
-      def initialize(name, args=nil, parent=nil, &block)
+      def initialize(name, args = nil, parent = nil, &block)
         @name = name
         @value = args
         @children = []
-        self.instance_eval(&block) if block_given?
+        instance_eval(&block) if block_given?
         @parse = block unless @children.any?
       end
 
-      def self.define(resource, name, value=nil, &block)
+      def self.define(resource, name, value = nil, &block)
         definition = new(name, value, &block)
         resource.append definition
         definition
@@ -19,9 +18,19 @@ module Spigot
       def parse(data)
         return {} if data.nil?
 
-        data.default_proc = proc{|h, k| h.key?(k.to_s) ? h[k.to_s] : nil} if data.is_a?(Hash)
+        data.default_proc = proc { |h, k| h.key?(k.to_s) ? h[k.to_s] : nil } if data.is_a?(Hash)
         if @children.empty?
+          unless data.is_a?(Hash)
+            raise Spigot::InvalidSchemaError, "Cannot extract :#{@name} from #{data.inspect}"
+          end
+
           value = @parse ? @parse.call(data[@name]) : data[@name]
+          if @value.is_a?(Class)
+            translator = @value.spigot.translator
+            translator.data = value
+            return { @value.name.underscore.to_sym => translator.format }
+          end
+
           return { @value.to_sym => value }
         end
 
@@ -37,21 +46,22 @@ module Spigot
       end
 
       def to_hash
-        result = {}; value = nil
+        result = {}
+        value = nil
         if @children.any?
           value = {}
-          @children.each{|child| value.merge!(child.to_hash) }
+          @children.each { |child| value.merge!(child.to_hash) }
         else
           value = @value
         end
 
-        result.merge!({@name => value})
+        result.merge!(@name => value)
       end
 
       # Spigot::Map::Definition.new(:user){ username :login }
       # Spigot::Map::Definition.new(:user){ username = :login }
       def method_missing(name, *args, &block)
-        name = name.to_s.gsub('=','').to_sym
+        name = name.to_s.gsub('=', '').to_sym
         @children << Spigot::Map::Definition.new(name, *args, &block)
       end
 

data/lib/spigot/map/option.rb

@@ -1,27 +1,15 @@
 module Spigot
   module Map
     class Option
-
       def initialize(&block)
         @conditions = []
         instance_eval(&block) if block_given?
       end
 
-      def primary_key(key=nil)
+      def primary_key(key = nil)
         return @primary_key if key.nil?
         @primary_key = key
       end
-
-      def foreign_key(key=nil)
-        return @foreign_key if key.nil?
-        @foreign_key = key
-      end
-
-      def conditions(attributes=nil)
-        return @attributes if attributes.nil?
-        @conditions = attributes
-      end
-
     end
   end
 end

data/lib/spigot/map/resource.rb

@@ -1,37 +1,42 @@
 module Spigot
   module Map
     class Resource
-
       attr_reader :definitions
 
       def initialize(name, &block)
         @name = name.to_s.underscore.to_sym
         @definitions = []
         @options = Spigot::Map::Option.new
-        self.instance_eval(&block) if block_given?
+        instance_eval(&block) if block_given?
       end
 
       def append(definition)
         @definitions << definition
       end
 
+      def associations
+        definitions.map do |definition|
+          value = definition.instance_variable_get(:@value)
+          definition if value.is_a?(Class)
+        end.compact
+      end
+
       def options(&block)
         @options = Spigot::Map::Option.new(&block)
       end
 
       def to_hash
         resource = {}
-        @definitions.each{|rule| resource.merge!(rule.to_hash) }
-        {@name => resource}
+        @definitions.each { |rule| resource.merge!(rule.to_hash) }
+        { @name => resource }
       end
 
       # Spigot::Map::Resource.new(:user){ username :login }
       # Spigot::Map::Resource.new(:user){ username = :login }
       def method_missing(name, *args, &block)
-        name = name.to_s.gsub('=','').to_sym
+        name = name.to_s.gsub('=', '').to_sym
         Spigot::Map::Definition.define(self, name, *args, &block)
       end
-
     end
   end
 end

data/lib/spigot/map/service.rb

@@ -1,7 +1,6 @@
- module Spigot
+module Spigot
   module Map
     class Service
-
       attr_reader :name
       attr_accessor :resources
 
@@ -17,7 +16,7 @@
       end
 
       def self.resource(name, &block)
-        service(:any){ resource(name, &block) }
+        service(:any) { resource(name, &block) }
       end
 
       def self.find(name)
@@ -33,11 +32,13 @@
       end
 
       def [](name)
-        resources.detect{|r| r.instance_variable_get(:@name).to_sym == name.to_sym}
+        resources.find { |r| r.instance_variable_get(:@name).to_sym == name.to_sym }
       end
 
       def self.extract(params)
         return params if current_map.nil?
+        return [nil, params] if params.is_a?(Array)
+
         name    = params.keys.first
         service = current_map.service(name)
 
@@ -53,7 +54,6 @@
       def self.current_map
         Spigot.config.map
       end
-
     end
   end
 end

data/lib/spigot/patch.rb

@@ -2,10 +2,10 @@ class String
   # Don't really like patching string here,
   # but it's fine for now.
   def underscore
-    self.gsub(/::/, '/').
-    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-    gsub(/([a-z\d])([A-Z])/,'\1_\2').
-    tr("-", "_").
-    downcase
+    gsub(/::/, '/')
+    .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+    .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+    .tr('-', '_')
+    .downcase
   end
 end

data/lib/spigot/proxy.rb

@@ -1,10 +1,15 @@
 module Spigot
   class Proxy
-
     ## Proxy
     #
     # Spigot::Proxy provides accessor methods used by the implementation
     # that could be useful for development or custom behavior
+    #
+    # Usage:
+    #
+    # User.spigot.find_or_create(data)
+    #
+    # User.spigot(:twitter).find_or_create(data)
 
     attr_reader :resource, :service
 
@@ -13,45 +18,45 @@ module Spigot
     #
     # @param service [String] This is the service that dictates the proxy.
     # @param resource [Object] This is the class implementing the proxy.
-    def initialize(resource, service=nil)
+    def initialize(resource, service = nil)
       @service  = service
       @resource = resource
     end
 
     ## #find
     #  Alias for find_by_api
-    def find(params={})
-      resource.find_by_api(service_scoped(params))
+    def find(params = {})
+      resource.find_by_api service_scoped(params)
     end
 
     ## #find_all
     #  Alias for find_all_by_api
-    def find_all(params={})
-      resource.find_all_by_api(service_scoped(params))
+    def find_all(params = {})
+      resource.find_all_by_api service_scoped(params)
     end
 
     ## #create
     #  Alias for create_by_api
-    def create(params={})
-      resource.create_by_api(service_scoped(params))
+    def create(params = {})
+      resource.create_by_api service_scoped(params)
     end
 
     ## #update
     #  Alias for update_by_api
-    def update(params={})
-      resource.update_by_api(service_scoped(params))
+    def update(params = {})
+      resource.update_by_api service_scoped(params)
     end
 
     ## #find_or_create
     #  Alias for find_or_create_by_api
-    def find_or_create(params={})
-      resource.find_or_create_by_api(service_scoped(params))
+    def find_or_create(params = {})
+      resource.find_or_create_by_api service_scoped(params)
     end
 
     ## #create_or_update
     #  Alias for create_or_update_by_api
-    def create_or_update(params={})
-      resource.create_or_update_by_api(service_scoped(params))
+    def create_or_update(params = {})
+      resource.create_or_update_by_api service_scoped(params)
     end
 
     ## #translator
@@ -66,6 +71,12 @@ module Spigot
       translator.resource_map
     end
 
+    ## #present?
+    # Returns a boolean if the current spigot map has a mapping for the current resource
+    def present?
+      translator.resource_map?(resource)
+    end
+
     ## #options
     # Return a hash of any service specific options for this translator. `Spigot.config` not included
     def options
@@ -74,17 +85,18 @@ module Spigot
 
     private
 
-    def service_scoped(params={})
+    def service_scoped(params = {})
       return params if @service.nil?
-      return {@service => params} if Spigot.config.map.nil?
+      return { @service => params } if Spigot.config.map.nil?
 
       key, data = Spigot::Map::Service.extract(params)
-      return {@service => params} if key.nil?
+      return { @service => params } if key.nil?
 
-      raise Spigot::InvalidServiceError, "You cannot specify two services" if key.to_sym != @service.to_sym
+      if key.to_sym != @service.to_sym
+        raise Spigot::InvalidServiceError, 'You cannot specify two services'
+      end
 
-      {key => data}
+      { key => data }
     end
-
   end
 end

data/lib/spigot/record.rb

@@ -1,12 +1,11 @@
 module Spigot
   class Record
-
     ## Record
     #
     # Spigot::Record is responsible for the instantiation and creation
     # of objects with the formatted data received from Spigot::Translator.
 
-    attr_reader :resource, :record, :data
+    attr_reader :service, :resource, :record, :data, :map
 
     # #initialize(resource, data)
     # Method to initialize a record.
@@ -14,10 +13,15 @@ module Spigot
     # @param resource [Object] This is the class implementing the record.
     # @param data     [Hash]   The already formatted data used to produce the object.
     # @param record   [Object] Optional record of `resource` type already in database.
-    def initialize(resource, data, record=nil)
-      @resource = resource
-      @data     = data
-      @record   = record
+    def initialize(service, resource, data, record = nil)
+      @resource     = resource
+      @data         = data
+      @record       = record
+      @service      = service
+
+      proxy = resource.spigot(service)
+      @map          = proxy.map if proxy.present?
+      @associations = map ? map.associations : []
     end
 
     ## #instantiate(resource, data)
@@ -25,8 +29,8 @@ module Spigot
     #
     # @param resource [Object] This is the class implementing the record.
     # @param data     [Hash]   The already formatted data used to produce the object.
-    def self.instantiate(resource, data)
-      new(resource, data).instantiate
+    def self.instantiate(service, resource, data)
+      new(service, resource, data).instantiate
     end
 
     ## #create(resource, data)
@@ -34,8 +38,8 @@ module Spigot
     #
     # @param resource [Object] This is the class implementing the record.
     # @param data     [Hash]   The already formatted data used to produce the object.
-    def self.create(resource, data)
-      new(resource, data).create
+    def self.create(service, resource, data)
+      new(service, resource, data).create
     end
 
     ## #update(resource, data)
@@ -44,8 +48,8 @@ module Spigot
     # @param resource [Object] This is the class implementing the record.
     # @param record   [Object] Optional record of `resource` type already in database.
     # @param data     [Hash]   The already formatted data used to produce the object.
-    def self.update(resource, record, data)
-      new(resource, data, record).update
+    def self.update(service, resource, record, data)
+      new(service, resource, data, record).update
     end
 
     ## #instantiate
@@ -57,7 +61,7 @@ module Spigot
     ## #create
     # Executes the create method on the implementing resource with formatted data.
     def create
-      resource.create(data)
+      data.is_a?(Array) ? create_by_array : create_by_hash(data)
     end
 
     ## #update
@@ -67,5 +71,28 @@ module Spigot
       record.save! if record.changed?
     end
 
+    private
+
+    def create_by_array
+      data.map { |record| create_by_hash(record) }
+    end
+
+    def create_by_hash(record)
+      resolve_associations(record) if @associations.any?
+      resource.create(record)
+    end
+
+    def resolve_associations(record)
+      @associations.each do |association|
+        submodel = association.instance_variable_get(:@value)
+
+        key = submodel.name.underscore.to_sym
+        submodel_data = record.delete(key)
+        if submodel_data
+          object = Record.create(service, submodel, submodel_data)
+          record.merge!("#{key}_id".to_sym => object.id)
+        end
+      end
+    end
   end
 end

data/lib/spigot/translator.rb

@@ -3,13 +3,10 @@ require 'hashie'
 
 module Spigot
   class Translator
-
     ## Translator
     #
-    # Translator reads the yaml file in the spigot config directory for
-    # a given service. It looks up the key for the resource class name
-    # passed in, then translates the data received into the format described
-    # in the yaml file for that resource.
+    # Translator looks up the key for the resource class name of the calling class,
+    # then translates the data received into the format described by the Spigot definition
     #
     # Relevant Configuration:
     # config.options_key  => The key which the Translator uses to configure a resource_map.
@@ -17,15 +14,15 @@ module Spigot
     attr_reader :service, :resource
     attr_accessor :data
 
-    OPTIONS = %w(primary_key foreign_key conditions).freeze
+    OPTIONS = %w(primary_key).freeze
 
-    ## #initialize(service, resource, data)
+    ## #initialize(resource, service=nil, data={})
     # Method to initialize a translator.
     #
-    # @param service  [Symbol] Service doing the translating. Must have a corresponding yaml file.
-    # @param resource [Object] This is the class using the translator.
+    # @param resource [Object] This is the class implementing the translator.
+    # @param service  [Symbol] Translation map specific to incoming data.
     # @param data     [Hash] Data in the format received by the api (optional).
-    def initialize(resource, service=nil, data={})
+    def initialize(resource, service = nil, data = {})
       @service = service
       @resource = resource.is_a?(Class) ? resource : resource.class
       raise InvalidResourceError, 'You must provide a calling resource' if resource.nil?
@@ -33,53 +30,37 @@ module Spigot
     end
 
     ## #format
-    # Formats the hash of data passed in to the format specified in the yaml file.
+    # Formats the hash of data passed in to the format specified in the Spigot defintion.
     def format
-      @format ||= data.is_a?(Array) ? data.map{|el| parse(el) } : parse(data)
+      @format ||= data.is_a?(Array) ? data.map { |el| parse(el) } : parse(data)
     end
 
-    ## #id
-    # The value at the foreign_key attribute specified in the resource options, defaults to 'id'.
-    def id
-      @id ||= lookup(foreign_key)
-    end
+    ## #conditions
+    # The conditions used when querying the database for an existing record
+    def conditions
+      values = []
+      if format.is_a?(Array)
+        values = format.map { |item| item[primary_key] }
+      else
+        values = format[primary_key]
+      end
 
-    ## #lookup(attribute)
-    # Find the value in the unformatted api data that matches the passed in key.
-    #
-    # @param attribute [String] The key pointing to the value you wish to lookup.
-    def lookup(attribute)
-      data.detect{|k, v| k.to_s == attribute.to_s }.try(:last)
+      { primary_key => values }
     end
 
     ## #options
     # Available options per resource.
-    #
-    # @primary_key:
-    #   Default: "#{service}_id"
-    #   Name of the column in your local database that serves as id for an external resource.
-    # @foreign_key:
-    #   Default: "id"
-    #   Name of the key representing the resource's ID in the data received from the API.
-    # @conditions:
-    #   Default: nil
-    #   Array of attributes included in the database query, these are names of columns in your database.
     def options
       @options ||= resource_map.instance_variable_get(:@options)
     end
 
+    # @primary_key:
+    #   Default: "#{service}_id"
+    #   Name of the column in your local database that serves as id for an external resource.
     def primary_key
       options.primary_key || "#{service}_id"
     end
 
-    def foreign_key
-      options.foreign_key || 'id'
-    end
-
-    def conditions
-      {primary_key => format[primary_key]}
-    end
-
     ## #resource_map
     # Return the mapped resource object for the current service and resource
     def resource_map
@@ -90,6 +71,10 @@ module Spigot
       @resource_map
     end
 
+    def resource_map?(key)
+      service_map[key.to_s.underscore]
+    end
+
     private
 
     def parse(dataset)
@@ -109,12 +94,11 @@ module Spigot
         if service.nil?
           raise MissingResourceError, "There is no #{resource.to_s.underscore} resource_map"
         else
-          raise InvalidServiceError, "No definition found for #{service}"
+          raise InvalidServiceError, "No #{resource.to_s} definition found for #{service}"
         end
       end
 
       @service_map
     end
-
   end
 end