spigot 0.1.0 → 0.2.0

data/lib/spigot/map/service.rb

@@ -0,0 +1,43 @@
+ module Spigot
+  module Map
+    class Service
+
+      attr_reader :name
+      attr_accessor :resources
+
+      def initialize(name)
+        @name = name.to_s.underscore.to_sym
+        @resources = []
+      end
+
+      def self.service(name, &block)
+        service = find(name) || Spigot::Map::Service.new(name)
+        service.instance_eval(&block) if block_given?
+        current_map.update(name, service)
+      end
+
+      def self.find(name)
+        current_map.service(name)
+      end
+
+      def resource(name, &block)
+        resources << Spigot::Map::Resource.new(name, &block)
+      end
+
+      def reset
+        @resources = []
+      end
+
+      def [](name)
+        resources.detect{|r| r.instance_variable_get(:@name).to_sym == name.to_sym}
+      end
+
+      private
+
+      def self.current_map
+        Spigot.config.map
+      end
+
+    end
+  end
+end

data/lib/spigot/patch.rb

@@ -1,6 +1,6 @@
 class String
   # Don't really like patching string here,
-  # but it's too clean not to.
+  # but it's fine for now.
   def underscore
     self.gsub(/::/, '/').
     gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').

data/lib/spigot/proxy.rb

@@ -14,6 +14,7 @@ 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(service, resource)
+      raise MissingServiceError, "No service definition found for #{service}" if Spigot.config.map.service(service).nil?
       @service  = service
       @resource = resource
     end
@@ -27,13 +28,13 @@ module Spigot
     ## #map
     # Return a hash of the data map the current translator is using
     def map
-      translator.mapping.reject{|k,v| k == 'spigot'}
+      translator.resource_map
     end
 
     ## #options
     # Return a hash of any service specific options for this translator. `Spigot.config` not included
     def options
-      translator.mapping['spigot'] || {}
+      translator.options || {}
     end
 
   end

data/lib/spigot/translator.rb

@@ -12,9 +12,7 @@ module Spigot
     # in the yaml file for that resource.
     #
     # Relevant Configuration:
-    # config.options_key  => The key which the Translator uses to configure a resource mapping.
-    # config.path         => The path which the Translator will look in to find the mappings.
-    # config.translations => A hash that overrides any mappings found in the `path` directory.
+    # config.options_key  => The key which the Translator uses to configure a resource_map.
 
     attr_reader :service, :resource
     attr_accessor :data
@@ -35,20 +33,10 @@ module Spigot
       @data = data || {}
     end
 
-    ## #format(custom_map)
+    ## #format
     # Formats the hash of data passed in to the format specified in the yaml file.
-    #
-    # @param custom_map  [Hash] Optional hash that you can prefer to use over the correlated translation.
-    # @param custom_data [Hash] Optional data that you can prefer to use over the @data currently on the object.
-    def format(custom_map=nil, custom_data=nil)
-      map     = Hashie::Mash.new(custom_map || mapping)
-      dataset = custom_data || data
-
-      if dataset.is_a?(Array)
-        dataset.map{|n| translate(map, n) }
-      elsif dataset.is_a?(Hash)
-        translate(map, dataset)
-      end
+    def format
+      @format ||= data.is_a?(Array) ? data.map{|el| parse(el) } : parse(data)
     end
 
     ## #id
@@ -78,81 +66,44 @@ module Spigot
     #   Default: nil
     #   Array of attributes included in the database query, these are names of columns in your database.
     def options
-      @options ||= mapping[Spigot.config.options_key] || {}
+      @options ||= resource_map.instance_variable_get(:@options)
     end
 
     def primary_key
-      options['primary_key'] || "#{service}_id"
+      options.primary_key || "#{service}_id"
     end
 
     def foreign_key
-      options['foreign_key'] || mapping.invert[primary_key] || 'id'
+      options.foreign_key || 'id'
     end
 
     def conditions
-      p_keys = [*(condition_keys.blank? ? primary_key : condition_keys)].map(&:to_s)
-      keys   = mapping.select{|k, v| p_keys.include?(v.to_s) }
-      format(keys)
+      {primary_key => format[primary_key]}
     end
 
-    ## #mapping
-    # Return a hash of the data map currently being used by this translator, including options.
-    def mapping
-      return @mapping if defined?(@mapping)
-      @mapping = translations[resource_key]
-      raise MissingResourceError, "There is no #{resource_key} mapping for #{service}" if @mapping.nil?
-      @mapping
+    ## #resource_map
+    # Return the mapped resource object for the current service and resource
+    def resource_map
+      return @resource_map if defined?(@resource_map)
+      resource_key = resource.to_s.underscore
+      @resource_map = service_map[resource_key]
+      raise MissingResourceError, "There is no #{resource_key} resource_map for #{service}" if @resource_map.nil?
+      @resource_map
     end
 
     private
 
-    def translate(map, dataset)
+    def parse(dataset)
       formatted = {}
-
-      if dataset.is_a?(Array)
-        return dataset.map{|element| translate(map, element)}
-      else
-        dataset.each_pair do |key, val|
-          next if key == Spigot.config.options_key
-          attribute = map[key]
-          next if attribute.nil?
-
-          result = attribute.is_a?(Hash) ? translate(attribute, val) : val
-          formatted.merge! mergeable_content(key, result, map)
-        end
+      resource_map.definitions.each do |rule|
+        result = rule.parse(dataset)
+        formatted.merge!(result)
       end
-
       formatted
     end
 
-    def mergeable_content(key, value, map)
-      if value.is_a?(Array)
-        {key.to_s => value}
-      elsif value.is_a?(Hash)
-        value
-      else
-        {map[key] => value}
-      end
-    end
-
-    def condition_keys
-      options['conditions'].to_s.split(',').map(&:strip)
-    end
-
-    def resource_key
-      resource.to_s.underscore
-    end
-
-    def translations
-      @translations ||= Hashie::Mash.new(Spigot.config.translations || YAML.load(translation_file))
-    end
-
-    def translation_file
-      begin
-        @translation_file ||= File.read(File.join(Spigot.config.path, "#{service.to_s}.yml"))
-      rescue Errno::ENOENT => e
-        raise MissingServiceError, "There is no service map for #{service} defined"
-      end
+    def service_map
+      Spigot.config.map ? Spigot.config.map.service(service) : {}
     end
 
   end

data/lib/spigot/version.rb

@@ -1,3 +1,3 @@
 module Spigot
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/script/console.rb

@@ -1,6 +1,32 @@
 require 'active_record'
 require 'spigot'
 
+Spigot.define do
+  service :github do
+    resource :active_user do
+      id        :github_id
+      full_name :name
+      login     :username
+      contact do
+        address   :address
+        telephone do
+          work :work_phone
+          home :home_phone
+        end
+        url :homepage do |value|
+          "https://github.com/#{value}"
+        end
+      end
+    end
+
+    resource :pull_request do
+      id        :id
+      title     :title
+      body      :body
+    end
+  end
+end
+
 ActiveRecord::Base.logger = Spigot.logger
 require File.join(Spigot.root, 'spec', 'support', 'active_record')
 
@@ -8,24 +34,4 @@ class ActiveUser < ActiveRecord::Base
   include Spigot::Base
 end
 
-map = {'activeuser' => {
-  'name' => 'name',
-  'username' => 'login',
-  'spigot' => {
-    'primary_key' => 'username'
-  }
-}}
-
-conditions = {'activeuser' => {
-  'name' => 'name',
-  'login' => 'username',
-  'spigot' => {
-    'primary_key' => 'username'
-  }
-}}
-
-Spigot.configure do |config|
-  config.translations = conditions
-end
-
 user = ActiveUser.create(name: 'Matt', username: 'mttwrnr', token: 'abc123')

data/spec/fixtures/data/active_user.rb

@@ -0,0 +1,17 @@
+module Spigot
+  module Data
+    class ActiveUser
+      class << self
+
+        def basic
+          {full_name: 'Dean Martin', login: 'classyasfuck', auth_token: '123abc'}
+        end
+
+        def alt
+          {full_name: 'Frank Sinatra', login: 'livetilidie', auth_token: '987zyx'}
+        end
+
+      end
+    end
+  end
+end

data/spec/fixtures/data/post.rb

@@ -0,0 +1,15 @@
+module Spigot
+  module Data
+    class Post
+      class << self
+        def basic
+          {'title' => 'Brief Article', 'body' => 'lorem ipsum'}
+        end
+
+        def alt
+          {'title' => 'Regular Article', 'body' => 'dolor sit amet', 'author' => 'Dean Martin'}
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/data/user.rb

@@ -0,0 +1,41 @@
+module Spigot
+  module Data
+    class User
+      class << self
+        def basic
+          {'id' => '123', 'full_name' => 'Dean Martin', 'login' => 'classyasfuck'}
+        end
+
+        def alt
+          {'full_name' => 'Frank Sinatra', 'login' => 'livetilidie', 'auth_token' => '456bcd'}
+        end
+
+        def full
+          basic.merge('auth_token' => '123abc')
+        end
+
+        def array
+          [full, alt]
+        end
+
+        def nested_array
+          {'account' => 'Rockafella', 'users' => array, 'count' => 2}
+        end
+
+        def nested
+          full.merge('login' => login_info)
+        end
+
+        def double_nested
+          full.merge('login' => {'contact' => login_info, 'last_seen_ip' => '127.0.0.1'})
+        end
+
+        private
+
+        def login_info
+          {'email' => 'dino@amore.io', 'user_name' => 'classyasfuck'}
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/mappings/active_user_map.rb

@@ -1,42 +1,78 @@
 module Spigot
   module Mapping
-
     class ActiveUser
 
-      def self.basic
-        {'active_user' => base}
+      def self.stub
+        template do
+          login :username
+          full_name :name
+        end
       end
 
       def self.with_options
-        {'active_user' => base.merge('spigot' => options)}
-      end
-
-      def self.non_unique_key
-        {'active_user' => base.merge('auth_token' => 'token', 'spigot' => non_unique)}
+        template do
+          login :username
+          full_name :name
+          options do
+            primary_key :username
+            foreign_key :login
+          end
+        end
       end
 
-      def self.with_invalid_options
-        {'active_user' => base.merge('spigot' => invalid_options)}
+      def self.non_unique_keys
+        template do
+          login :username
+          full_name :name
+          auth_token :token
+          options do
+            primary_key :token
+            foreign_key :auth_token
+          end
+        end
       end
 
       private
 
-      def self.base
-        {'full_name' => 'name', 'login' => 'username'}
+      def self.template(&block)
+        Spigot.define do
+          service :github do
+            resource :active_user do
+              self.instance_eval(&block)
+            end
+          end
+        end
       end
 
-      def self.options
-        {'primary_key' => 'username', 'foreign_key' => 'login'}
-      end
+      # def self.basic
+      #   {'active_user' => base}
+      # end
 
-      def self.non_unique
-        {'primary_key' => 'token', 'foreign_key' => 'auth_token'}
-      end
+      # def self.non_unique_key
+      #   {'active_user' => base.merge('auth_token' => 'token', 'spigot' => non_unique)}
+      # end
 
-      def self.invalid_options
-        {'primary_key' => 'nosuchcolumn', 'foreign_key' => 'nosuchkey'}
-      end
-    end
+      # def self.with_invalid_options
+      #   {'active_user' => base.merge('spigot' => invalid_options)}
+      # end
+
+      # private
+
+      # def self.base
+      #   {'full_name' => 'name', 'login' => 'username'}
+      # end
 
+      # def self.options
+      #   {'primary_key' => 'username', 'foreign_key' => 'login'}
+      # end
+
+      # def self.non_unique
+      #   {'primary_key' => 'token', 'foreign_key' => 'auth_token'}
+      # end
+
+      # def self.invalid_options
+      #   {'primary_key' => 'nosuchcolumn', 'foreign_key' => 'nosuchkey'}
+      # end
+    end
   end
 end