spigot 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 78085ef374e7bfcf77dd307ab4d659152baddaf0
-  data.tar.gz: 8852de5e0d8a2e3ad3ea6d2ba467b61483617be3
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Mzk3YmFlOGM4MmQ1M2JkNDBmNjBjYzZmZTNmYWFkOGJjMDE5MGMyMg==
+  data.tar.gz: !binary |-
+    ZTE4ZGJjNzQyYzk2YzZhZTcwNmQxY2I2NzdmNzgyMjZkNDJmZjllYw==
 SHA512:
-  metadata.gz: 0b71f04cd9d4677e6a090cf59460b6ef0619b88cddb4f4fd9ce2f8f890b4e93ddf4288def1ccd15205675e0f4b924e85e78b3bbea25f767b68f17cc17ab69e84
-  data.tar.gz: 2acb389f90be427885ee81c1159d6925b32344d3bbd8e148aa18232052182e4bf28b59f8a48ed14c9b12af3c32be3912466cb7c109ea1c91bdf5c2d4ea4f3f10
+  metadata.gz: !binary |-
+    ZTUzMTM5MWQ3ZGEzYTk4ZDBmMGQ2Mzc1M2MzNGI0NjM4ODE4N2RiZjc2NGQz
+    M2FjZGQzM2JjMWQ0ZjM3Y2FkMzc0MGU4NzlhNDE2YzA4MDhiNmQwNmY5Y2U1
+    OTU4MDk2NTY0ZGEwY2IxYWI0NWVhODFlODdmNDQxNTEwZWE2ZmI=
+  data.tar.gz: !binary |-
+    OTk3ZDdkY2UwZjgxOGMxZGM1MzIwN2FjOGExZTQ4NTRkZDVmYmQ2MTM3NzBm
+    ZGRjMDI0NTg1MmU3MWNkNDgwMTM0N2VlMzU1NTE3ZTg1MzZlNTE4M2JjZmRh
+    MjdkMTY1MTZlNzhkNzZhNDgzMDZhNGZiZjgyMWY1YjFhMjk5YjA=

data/lib/spigot/active_record.rb

@@ -19,7 +19,7 @@ module Spigot
       # @param service [Symbol] Service from which the data was received
       # @param api_data [Hash] The data as received from the remote api, unformatted.
       def find_all_by_api(service, api_data)
-        find_by_translator Translator.new(service, self, api_data)
+        find_by_translator Translator.new(self, service, api_data)
       end
 
       ## #create_by_api(service, api_data)
@@ -29,7 +29,7 @@ module Spigot
       # @param service [Symbol] Service from which the data was received
       # @param api_data [Hash] The data as received from the remote api, unformatted.
       def create_by_api(service, api_data)
-        create_by_translator Translator.new(service, self, api_data)
+        create_by_translator Translator.new(self, service, api_data)
       end
 
       ## #update_by_api(service, api_data)
@@ -40,7 +40,7 @@ module Spigot
       # @param service [Symbol] Service from which the data was received
       # @param api_data [Hash] The data as received from the remote api, unformatted.
       def update_by_api(service, api_data)
-        babel = Translator.new(service, self, api_data)
+        babel = Translator.new(self, service, api_data)
         record = find_by_translator(babel).first
         update_by_translator(babel, record) if record.present?
       end
@@ -53,7 +53,7 @@ module Spigot
       # @param service [Symbol] Service from which the data was received
       # @param api_data [Hash] The data as received from the remote api, unformatted.
       def find_or_create_by_api(service, api_data)
-        babel = Translator.new(service, self, api_data)
+        babel = Translator.new(self, service, api_data)
         find_by_translator(babel).first || create_by_translator(babel)
       end
 
@@ -65,7 +65,7 @@ module Spigot
       # @param service [Symbol] Service from which the data was received
       # @param api_data [Hash] The data as received from the remote api, unformatted.
       def create_or_update_by_api(service, api_data)
-        babel = Translator.new(service, self, api_data)
+        babel = Translator.new(self, service, api_data)
         record = find_by_translator(babel).first
         record.present? ? update_by_translator(babel, record) : create_by_translator(babel)
       end

data/lib/spigot/base.rb

@@ -22,7 +22,7 @@ module Spigot
       # @param service [Symbol] Service which will be doing the translating. Must have a corresponding yaml file
       # @param api_data [Hash] The data as received from the remote api, unformatted.
       def formatted_api_data(service, api_data)
-        Translator.new(service, self, api_data).format
+        Translator.new(self, service, api_data).format
       end
 
       # #self.spigot

data/lib/spigot/map/service.rb

@@ -16,6 +16,10 @@
         current_map.update(name, service)
       end
 
+      def self.resource(name, &block)
+        service(:any){ resource(name, &block) }
+      end
+
       def self.find(name)
         current_map.service(name)
       end

data/lib/spigot/translator.rb

@@ -25,9 +25,8 @@ module Spigot
     # @param service  [Symbol] Service doing the translating. Must have a corresponding yaml file.
     # @param resource [Object] This is the class using the translator.
     # @param data     [Hash] Data in the format received by the api (optional).
-    def initialize(service, resource, data={})
+    def initialize(resource, service=nil, data={})
       @service = service
-      raise InvalidServiceError, 'You must provide a service name' if service.nil? || service == ''
       @resource = resource.is_a?(Class) ? resource : resource.class
       raise InvalidResourceError, 'You must provide a calling resource' if resource.nil?
       @data = data || {}
@@ -103,7 +102,18 @@ module Spigot
     end
 
     def service_map
-      Spigot.config.map ? Spigot.config.map.service(service) : {}
+      return {} if Spigot.config.map.nil?
+
+      @service_map = Spigot.config.map.service(service || :any)
+      if @service_map.nil?
+        if service.nil?
+          raise MissingResourceError, "There is no #{resource_key} resource_map"
+        else
+          raise InvalidServiceError, "No definition found for #{service}"
+        end
+      end
+
+      @service_map
     end
 
   end

data/lib/spigot/version.rb

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

data/spec/fixtures/mappings/user_map.rb

@@ -40,6 +40,45 @@ module Spigot
         end
       end
 
+      def self.serviceless
+        Spigot.define do
+          resource :user do
+            full_name :name
+            login     :username
+          end
+        end
+      end
+
+      def self.multiple_serviceless
+        Spigot.define do
+          resource :user do
+            full_name :name
+            login     :username
+          end
+
+          resource :post do
+            title :headline
+            body  :body
+          end
+        end
+      end
+
+      def self.service_and_serviceless
+        Spigot.define do
+          resource :user do
+            full_name :name
+            login     :username
+          end
+
+          service :github do
+            resource :user do
+              login :name
+              full_name :username
+            end
+          end
+        end
+      end
+
       def self.nested_twice
         template do
           full_name :name

data/spec/spec_helper.rb

@@ -14,6 +14,7 @@ end
 
 # Mocked Classes
 User = Class.new(Hashie::Mash)
+Post = Class.new(Hashie::Mash)
 
 class ActiveUser < ActiveRecord::Base
   include Spigot::Base

data/spec/spigot/map/base_spec.rb

@@ -21,6 +21,15 @@ describe Spigot::Map::Base do
       subject.define
     end
 
+    it 'does not require a service' do
+      subject.define do
+        resource :user
+      end
+
+      subject.services.length.should eq(1)
+      subject.services.first.name.should eq(:any)
+    end
+
     it 'works with one service' do
       subject.define do
         service :github

data/spec/spigot/translator_spec.rb

@@ -3,27 +3,27 @@ require 'spec_helper'
 describe Spigot::Translator do
   context '#initialize' do
     before{ Spigot::Mapping::User.basic }
-    it 'requires a service' do
+    it 'does not require a service' do
       expect{
-        Spigot::Translator.new(nil, Struct)
-      }.to raise_error(Spigot::InvalidServiceError)
+        Spigot::Translator.new(Struct, nil)
+      }.to_not raise_error(Spigot::InvalidServiceError)
     end
 
     it 'requires a resource' do
       expect{
-        Spigot::Translator.new(:github, nil)
+        Spigot::Translator.new(nil, :github)
       }.to raise_error(Spigot::InvalidResourceError)
     end
 
     it 'accepts an instance or class resource' do
-      by_class    = Spigot::Translator.new(:github, User)
-      by_instance = Spigot::Translator.new(:github, User.new)
+      by_class    = Spigot::Translator.new(User)
+      by_instance = Spigot::Translator.new(User.new)
       expect(by_class.resource).to eq(by_instance.resource)
     end
   end
 
   context '.id' do
-    let(:subject){ Spigot::Translator.new(:github, User.new, Spigot::Data::User.basic) }
+    let(:subject){ Spigot::Translator.new(User.new, :github, Spigot::Data::User.basic) }
     before{ Spigot::Mapping::User.basic }
     it 'returns the value at the foreign_key' do
       subject.stubs(:foreign_key).returns('id')
@@ -33,7 +33,7 @@ describe Spigot::Translator do
 
   context '.format' do
     context 'with a missing resource map' do
-      let(:subject){ Spigot::Translator.new(:github, User.new, Spigot::Data::User.basic) }
+      let(:subject){ Spigot::Translator.new(User.new, :github, Spigot::Data::User.basic) }
       it 'raises error with a missing resource map' do
         expect{
           subject.format
@@ -44,7 +44,7 @@ describe Spigot::Translator do
     context 'with a valid resource map' do
       context 'with a simple map' do
         let(:data){ Spigot::Data::User.basic }
-        let(:subject){ Spigot::Translator.new(:github, User.new, data) }
+        let(:subject){ Spigot::Translator.new(User.new, :github, data) }
         before{ Spigot::Mapping::User.basic }
         it 'returns empty hash from nil data' do
           subject.data = {}
@@ -58,7 +58,7 @@ describe Spigot::Translator do
 
       context 'with a nested map' do
         let(:data){ Spigot::Data::User.nested }
-        let(:subject){ Spigot::Translator.new(:github, User.new, data) }
+        let(:subject){ Spigot::Translator.new(User.new, :github, data) }
         before{ Spigot::Mapping::User.nested }
 
         it 'traverses into the nested hash' do
@@ -72,7 +72,7 @@ describe Spigot::Translator do
 
       context "nested twice" do
         let(:data){Spigot::Data::User.double_nested}
-        let(:subject){Spigot::Translator.new(:github, User.new, data)}
+        let(:subject){Spigot::Translator.new(User.new, :github, data)}
         before{ Spigot::Mapping::User.nested_twice }
 
         it 'traverses multiple levels' do
@@ -87,7 +87,7 @@ describe Spigot::Translator do
 
       context 'with an array of values' do
         let(:data){Spigot::Data::User.array}
-        let(:subject){Spigot::Translator.new(:github, User.new, data)}
+        let(:subject){Spigot::Translator.new(User.new, :github, data)}
         before{ Spigot::Mapping::User.basic }
 
         it 'returns an array of formatted data' do
@@ -100,7 +100,7 @@ describe Spigot::Translator do
 
       context 'with a nested array of values' do
         let(:data){ Spigot::Data::User.nested_array }
-        let(:subject){Spigot::Translator.new(:github, User.new, data)}
+        let(:subject){Spigot::Translator.new(User.new, :github, data)}
         before{ Spigot::Mapping::User.nested_array }
 
         it 'handles a nested array of values' do
@@ -114,7 +114,7 @@ describe Spigot::Translator do
 
       context 'with a namedspaced resource' do
         let(:data){ Spigot::Data::Post.basic }
-        let(:subject){Spigot::Translator.new(:github, Wrapper::Post.new, data)}
+        let(:subject){Spigot::Translator.new(Wrapper::Post.new, :github, data)}
         before{ Spigot::Mapping::Post.basic }
 
         it 'accesses the wrapper/post key' do
@@ -127,7 +127,7 @@ describe Spigot::Translator do
 
       context 'with an interpolated value' do
         let(:data){ Spigot::Data::User.basic }
-        let(:subject){ Spigot::Translator.new(:github, User.new, data) }
+        let(:subject){ Spigot::Translator.new(User.new, :github, data) }
         before{ Spigot::Mapping::User.interpolated }
         it 'reads one layer' do
           expect(subject.format).to eq({name: 'Dean Martin', username: '@classyasfuck'})
@@ -136,17 +136,55 @@ describe Spigot::Translator do
 
       context 'with a nested interpolated value' do
         let(:data){ Spigot::Data::User.nested }
-        let(:subject){ Spigot::Translator.new(:github, User.new, data) }
+        let(:subject){ Spigot::Translator.new(User.new, :github, data) }
         before{ Spigot::Mapping::User.nested_interpolation }
         it 'reads one layer' do
           expect(subject.format).to eq({name: 'Dean Martin', contact: 'dino@amore.io', username: '@classyasfuck'})
         end
       end
+
+      context 'without a service' do
+        let(:data){ Spigot::Data::User.basic }
+        let(:subject){ Spigot::Translator.new(User.new, nil, data) }
+        before{ Spigot::Mapping::User.serviceless }
+        it 'reads one layer' do
+          expect(subject.format).to eq({name: 'Dean Martin', username: 'classyasfuck'})
+        end
+
+        it 'does not use the any definition with an invalid service' do
+          subject = Spigot::Translator.new(User.new, :github, data)
+          expect {
+            subject.format
+          }.to raise_error(Spigot::InvalidServiceError)
+        end
+      end
+
+      context 'multiple resources without a service' do
+        before{ Spigot::Mapping::User.multiple_serviceless }
+        it 'reads one layer' do
+          user = Spigot::Translator.new(User.new, nil, Spigot::Data::User.basic)
+          post = Spigot::Translator.new(Post.new, nil, Spigot::Data::Post.basic)
+
+          expect(user.format).to eq({name: 'Dean Martin', username: 'classyasfuck'})
+          expect(post.format).to eq({headline: 'Brief Article', body: 'lorem ipsum'})
+        end
+      end
+
+      context 'with and without service' do
+        before{ Spigot::Mapping::User.service_and_serviceless }
+        it 'prefers the service definition' do
+          service = Spigot::Translator.new(User.new, :github, Spigot::Data::User.basic)
+          no_service = Spigot::Translator.new(User.new, nil, Spigot::Data::User.basic)
+
+          expect(service.format).to eq({name: 'classyasfuck', username: 'Dean Martin'})
+          expect(no_service.format).to eq({name: 'Dean Martin', username: 'classyasfuck'})
+        end
+      end
     end
   end
 
   context '#lookup' do
-    let(:subject){Spigot::Translator.new(:github, User.new, {a: '1'})}
+    let(:subject){Spigot::Translator.new(User.new, :github, {a: '1'})}
 
     it 'returns the value at a given key' do
       subject.lookup(:a).should eq('1')
@@ -155,7 +193,7 @@ describe Spigot::Translator do
 
   context '#conditions' do
     let(:data){ Spigot::Data::User.basic }
-    let(:subject){Spigot::Translator.new(:github, User.new, data)}
+    let(:subject){Spigot::Translator.new(User.new, :github, data)}
 
     context 'without conditions specified' do
       before{ Spigot::Mapping::User.basic }
@@ -177,7 +215,7 @@ describe Spigot::Translator do
   end
 
   context '#options' do
-    let(:subject){ Spigot::Translator.new(:github, User.new, {remote_id: '987'}) }
+    let(:subject){ Spigot::Translator.new(User.new, :github, {remote_id: '987'}) }
 
     context 'without options provided' do
       before{ Spigot::Mapping::User.basic }

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: spigot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Matthew Werner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-09 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -42,84 +42,84 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Spigot provides a clean interface translating API data into context relevant
@@ -182,17 +182,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: Spigot provides a clean interface translating API data into context relevant