spigot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6e0174fc401969ff57755d4eb751c1ebb3bd5c5
-  data.tar.gz: 2844483e9860825c20e4e6b6d255ffe80586843c
+  metadata.gz: 78085ef374e7bfcf77dd307ab4d659152baddaf0
+  data.tar.gz: 8852de5e0d8a2e3ad3ea6d2ba467b61483617be3
 SHA512:
-  metadata.gz: 6edf56a3600624852a424f314faf8a1b092eb77a3e216e894964972a081a86348033f52f485540a0970a3c006683a91e7ebfcdba39a5ab9b6c489e08dd34d7ee
-  data.tar.gz: a88764f01212671cf27efdcf1d12218ceec4915b49c767c17b2b1b8560cabefc7ddca0e9ea7ab93686fe1d36f95d9f035cb46c793bd7077d0181eb57094cfc89
+  metadata.gz: 0b71f04cd9d4677e6a090cf59460b6ef0619b88cddb4f4fd9ce2f8f890b4e93ddf4288def1ccd15205675e0f4b924e85e78b3bbea25f767b68f17cc17ab69e84
+  data.tar.gz: 2acb389f90be427885ee81c1159d6925b32344d3bbd8e148aa18232052182e4bf28b59f8a48ed14c9b12af3c32be3912466cb7c109ea1c91bdf5c2d4ea4f3f10

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 .rspec
+.DS_Store
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -1,48 +1,41 @@
 # Spigot
 
+[![Build Status](https://travis-ci.org/mwerner/spigot.png?branch=master)](https://travis-ci.org/mwerner/spigot)
+[![Code Climate](https://codeclimate.com/github/mwerner/spigot.png)](https://codeclimate.com/github/mwerner/spigot)
+
 Spigot is an attempt to bring some sanity to consuming external API data. Without Spigot, you need
 to do this manual mapping at creation, such as:
 
-    Pull.where(number: pull.number).first_or_initialize.tap do |t|
-      t.title      = pull.title
-      t.body       = pull.body
-      t.url        = pull._links.html.href
-      t.head_ref   = pull.head.ref
-      t.head_sha   = pull.head.sha
-      t.base_ref   = pull.base.ref
-      t.base_sha   = pull.base.sha
-      t.save
-    end
-
-Spigot reads config files in an expected format to map the data you receive to the columns of your database.
-This becomes particularly difficult as you start having multiple sources for the same resource (ex: users).
+    if params[:data].present?
+      data = params[:data]
+      record = User.where(external_id: data[:id]).first
 
-Spigot is able to do the translation for you and put the API data into a language your implementation understands.
-This leaves you with a simple statement to accomplish the same as above:
+      if record.nil?
+        url = "https://github.com/#{data[:login]}"
 
-    Pull.find_or_create_by_api(:github, pull)
+        user = User.new({
+          name: data[:first_name],
+          email: data[:email_address],
+          url: url
+        })
 
-Much better. [Read More](https://github.com/mwerner/spigot/wiki)
+        if data[:profile].present?
+          user.bio = data[:profile][:text]
+        end
 
-## Example
-
-    # Our Model
-    class User < ActiveRecord::Base
-      include Spigot::Base
+        user.save!
+      end
     end
 
-    # Api Data Received
-    data = JSON.parse("{\"full_name\":\"Dean Martin\",\"login\":\"dino@amore.io\",\"token\":\"abc123\"}")
+This becomes particularly difficult as you start having multiple external sources for the same resource (ex: users from both twitter and facebook).
+Spigot uses a ruby api to map the data you receive to the columns of your database. As a result, you're
+able to convey a mapping of their structure into your attributes in a concise format. Afterwards, you can accomplish the above work in a simple statement:
+
+    User.find_or_create_by_api(:github, params[:data])
 
-    # Spigot yaml file to map this data correctly
-    user:
-      full_name: name
-      login: email
-      token: auth
+Much better.
 
-    # Usage
-    User.find_or_create_by_api(:github, data).inspect
-    #=> #<User id: 1, name: "Dean Martin", email: "dino@amore.io", token: "abc123">
+[Read More](http://mwerner.github.io/spigot/)
 
 ## Installation
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+
+task :spec do
+  system("rspec spec/")
+end
+
+task :default => [:spec]

data/examples/active_record.rb

@@ -23,28 +23,31 @@ class User < ActiveRecord::Base
   include Spigot::Base
 end
 
-Spigot.configure do |config|
-  config.translations = {'user' => {
-    'id'         => 'github_id',
-    'login'      => 'username',
-    'avatar_url' => 'image_url',
-    'url'        => 'profile_url',
-    'spigot' => {
-      'primary_key' => 'username'
-    }
-  }}
+Spigot.define do
+  service :github do
+    resource :user do
+      id :github_id
+      login :username
+      avatar_url :image_url
+      url :profile_url
+      options do
+        primary_key :username
+      end
+    end
+  end
 end
 
-puts "Making a request to an external API (Github)"
-response = Net::HTTP.get_response URI.parse("https://api.github.com/users/mwerner")
-puts "Parse the response: `data = JSON.parse(response.body)`"
+profile_url = "https://api.github.com/users/mwerner"
+puts "Making a request to an external API (Github): #{profile_url}"
+response = Net::HTTP.get_response URI.parse(profile_url)
+puts "Parse the response:\n `data = JSON.parse(response.body)`"
 data = JSON.parse(response.body)
 
-puts "\nReceived a whole bunch of data: "
+puts "\nIt Returned a whole bunch of data: "
 puts "#{data.inspect[0..100]}... etc, etc, etc (#{data.keys.length} more keys received)"
 
 puts "\nWe don't want to use all of it. We can define a map on Spigot:"
-puts User.spigot(:github).map.inspect
+puts User.spigot(:github).map.to_hash.inspect
 puts "Each key is an attribute received from the API, and the corresponding value is our column name."
 
 puts "\nWe define our primary key in the spigot `User` options, so we know how to check if the record already exists:"

data/examples/model.rb

@@ -1,12 +1,39 @@
 require 'spigot'
 
-Spigot.configure do |config|
-  config.translations = {
-    'user' => {
-      'full_name' => 'name',
-      'login' => 'username'
-    }
-  }
+Spigot.define do
+  service :twitter do
+    resource :user do
+      id       :twitter_id
+      name     :name
+      username :username
+    end
+  end
+end
+
+Spigot.define do
+  service :github do
+    resource :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
 
 class User
@@ -29,6 +56,10 @@ class User
   end
 end
 
+puts "Map Built:"
+puts Spigot.config.map.to_hash
+
 user = User.build
+puts "\nUser Parsed:"
 puts user.name
 puts user.inspect

data/lib/spigot.rb

@@ -3,21 +3,33 @@ require "spigot/errors"
 require "spigot/patch"
 
 module Spigot
-  autoload :Configuration, 'spigot/configuration'
-  autoload :Translator,    'spigot/translator'
-  autoload :Record,        'spigot/record'
-  autoload :Base,          'spigot/base'
   autoload :ActiveRecord,  'spigot/active_record'
+  autoload :Base,          'spigot/base'
+  autoload :Configuration, 'spigot/configuration'
   autoload :Proxy,         'spigot/proxy'
+  autoload :Record,        'spigot/record'
+  autoload :Translator,    'spigot/translator'
+  module Map
+    autoload :Base,        'spigot/map/base'
+    autoload :Definition,  'spigot/map/definition'
+    autoload :Option,      'spigot/map/option'
+    autoload :Resource,    'spigot/map/resource'
+    autoload :Service,     'spigot/map/service'
+  end
 
-  def self.config
-    Configuration.instance
+  def self.define(&block)
+    (config.map || Spigot::Map::Base.new).define(&block)
   end
 
   def self.configure
     yield config
   end
 
+  def self.config
+    Configuration.instance
+  end
+
+  ##=> Support
   def self.root
     File.expand_path('../..', __FILE__)
   end

data/lib/spigot/configuration.rb

@@ -4,13 +4,12 @@ module Spigot
   class Configuration
     include Singleton
 
-    attr_accessor :path, :translations, :options_key, :logger
+    attr_accessor :options_key, :logger, :map
 
     @@defaults = {
-      path: 'config/spigot',
-      translations: nil,
-      options_key: 'spigot',
-      logger: nil
+      options_key: 'options',
+      logger: nil,
+      map: nil
     }
 
     def self.defaults

data/lib/spigot/map/base.rb

@@ -0,0 +1,44 @@
+module Spigot
+  module Map
+    class Base
+
+      attr_reader :services
+
+      def initialize
+        @services = []
+        Spigot.config.map = self
+      end
+
+      def define(&block)
+        Spigot::Map::Service.class_eval(&block) if block_given?
+      end
+
+      def update(name, service)
+        @services.reject!{|s| s.name == name.to_s.underscore.to_sym}
+        @services << service
+      end
+
+      def reset
+        @services = []
+      end
+
+      def service(name)
+        services.detect{|service| service.name == name.to_s.underscore.to_sym}
+      end
+
+      def to_hash
+        hash = {};
+        services.each do |service|
+          service_map = {}
+          service.resources.each{|resource| service_map.merge!(resource.to_hash) }
+          hash.merge!(service.name.to_sym => service_map)
+        end
+        hash
+      end
+
+      def inspect
+        "#<Spigot::Map::Base #{to_hash.to_s}>"
+      end
+    end
+  end
+end

data/lib/spigot/map/definition.rb

@@ -0,0 +1,69 @@
+module Spigot
+  module Map
+    class Definition
+
+      def initialize(name, args=nil, parent=nil, &block)
+        @name = name
+        @value = args
+        @children = []
+        self.instance_eval(&block) if block_given?
+        @parse = block unless @children.any?
+      end
+
+      def self.define(resource, name, value=nil, &block)
+        definition = new(name, value, &block)
+        resource.append definition
+        definition
+      end
+
+      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)
+        if @children.empty?
+          value = @parse ? @parse.call(data[@name]) : data[@name]
+          return { @value.to_sym => value }
+        end
+
+        if data[@name].is_a?(Array)
+          set = []
+          data[@name].each do |element|
+            set << parse_children(element)
+          end
+          { @name.to_sym => set }
+        else
+          parse_children(data[@name])
+        end
+      end
+
+      def to_hash
+        result = {}; value = nil
+        if @children.any?
+          value = {}
+          @children.each{|child| value.merge!(child.to_hash) }
+        else
+          value = @value
+        end
+
+        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
+        @children << Spigot::Map::Definition.new(name, *args, &block)
+      end
+
+      private
+
+      def parse_children(data)
+        child_hash = {}
+        @children.each do |child|
+          child_hash.merge!(child.parse(data))
+        end
+        child_hash
+      end
+    end
+  end
+end

data/lib/spigot/map/option.rb

@@ -0,0 +1,27 @@
+module Spigot
+  module Map
+    class Option
+
+      def initialize(&block)
+        @conditions = []
+        instance_eval(&block) if block_given?
+      end
+
+      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

@@ -0,0 +1,37 @@
+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?
+      end
+
+      def append(definition)
+        @definitions << definition
+      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}
+      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
+        Spigot::Map::Definition.define(self, name, *args, &block)
+      end
+
+    end
+  end
+end