spigot 0.2.2 → 0.3.0

data/lib/spigot/version.rb

@@ -1,3 +1,4 @@
+# Spigot::VERSION
 module Spigot
-  VERSION = "0.2.2"
+  VERSION = '0.3.0'
 end

data/script/active_record.rb

@@ -0,0 +1,35 @@
+ActiveRecord::Base.establish_connection({
+  adapter: 'sqlite3',
+  database: ':memory:'
+})
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :active_users, force: true do |t|
+    t.integer :github_id
+    t.integer :profile_id
+    t.string :name
+    t.string :username
+    t.string :token
+  end
+
+  create_table :posts, force: true do |t|
+    t.integer :active_user_id
+    t.string  :title
+    t.text    :body
+    t.timestamps
+  end
+
+  create_table :events, force: true do |t|
+    t.string  :github_id
+    t.integer :active_user_id
+    t.string  :name
+    t.timestamps
+  end
+
+  create_table :profiles, force: true do |t|
+    t.string :image_url
+    t.timestamps
+  end
+end

data/script/console.rb

@@ -15,6 +15,17 @@ Spigot.resource(:active_user) do
       "https://github.com/#{value}"
     end
   end
+  options do
+    primary_key :username
+  end
+end
+
+Spigot.resource(:post) do
+  headline :title
+  content  :body
+  options do
+    primary_key :username
+  end
 end
 
 Spigot.service(:twitter) do
@@ -25,10 +36,16 @@ Spigot.service(:twitter) do
 end
 
 ActiveRecord::Base.logger = Spigot.logger
-require File.join(Spigot.root, 'spec', 'support', 'active_record')
+require File.join(Spigot.root, 'script', 'active_record')
 
 class ActiveUser < ActiveRecord::Base
   include Spigot::Base
+  has_many :posts
+end
+
+class Post < ActiveRecord::Base
+  include Spigot::Base
+  belongs_to :user
 end
 
-user = ActiveUser.create(name: 'Matt', username: 'mttwrnr', token: 'abc123')
+ActiveUser.create(name: 'Matt', username: 'mwerner', token: 'abc123')

data/spec/fixtures/data/active_user.rb

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

data/spec/fixtures/data/post.rb

@@ -3,11 +3,7 @@ module Spigot
     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'}
+          { 'title' => 'Brief Article', 'body' => 'lorem ipsum' }
         end
       end
     end

data/spec/fixtures/data/user.rb

@@ -3,11 +3,11 @@ module Spigot
     class User
       class << self
         def basic
-          {'id' => '123', 'full_name' => 'Dean Martin', 'login' => 'classyasfuck'}
+          { 'id' => '123', 'full_name' => 'Dean Martin', 'login' => 'classyasfuck' }
         end
 
         def alt
-          {'full_name' => 'Frank Sinatra', 'login' => 'livetilidie', 'auth_token' => '456bcd'}
+          { 'full_name' => 'Frank Sinatra', 'login' => 'livetilidie', 'auth_token' => '456bcd' }
         end
 
         def full
@@ -19,7 +19,7 @@ module Spigot
         end
 
         def nested_array
-          {'account' => 'Rockafella', 'users' => array, 'count' => 2}
+          { 'account' => 'Rockafella', 'users' => array, 'count' => 2 }
         end
 
         def nested
@@ -27,13 +27,13 @@ module Spigot
         end
 
         def double_nested
-          full.merge('login' => {'contact' => login_info, 'last_seen_ip' => '127.0.0.1'})
+          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'}
+          { 'email' => 'dino@amore.io', 'user_name' => 'classyasfuck' }
         end
       end
     end

data/spec/fixtures/mappings/active_user_map.rb

@@ -1,7 +1,6 @@
 module Spigot
   module Mapping
     class ActiveUser
-
       def self.stub
         template do
           login :username
@@ -24,7 +23,16 @@ module Spigot
           full_name :name
           options do
             primary_key :username
-            foreign_key :login
+          end
+        end
+      end
+
+      def self.invalid_primary_key
+        template do
+          login :username
+          full_name :name
+          options do
+            primary_key :doesnotexist
           end
         end
       end
@@ -36,7 +44,6 @@ module Spigot
           auth_token :token
           options do
             primary_key :token
-            foreign_key :auth_token
           end
         end
       end
@@ -47,12 +54,11 @@ module Spigot
         Spigot.define do
           service :github do
             resource :active_user do
-              self.instance_eval(&block)
+              instance_eval(&block)
             end
           end
         end
       end
-
     end
   end
 end

data/spec/fixtures/mappings/post_map.rb

@@ -1,22 +1,10 @@
-module Spigot
-  module Mapping
-    class Post
-
-
-      def self.basic
-
-        Spigot.define do
-          service :github do
-            resource 'wrapper/post' do
-              title :title
-              body :description
-            end
-          end
-        end
-
+module Spigot::Mapping::Post
+  def self.basic
+    Spigot.service(:github) do
+      resource 'wrapper/post' do
+        title :title
+        body :description
       end
-
-
     end
   end
 end

data/spec/fixtures/mappings/user_map.rb

@@ -1,7 +1,6 @@
 module Spigot
   module Mapping
     class User
-
       def self.basic
         template do
           full_name :name
@@ -116,7 +115,6 @@ module Spigot
           login     :username
           options do
             primary_key :username
-            foreign_key :login
           end
         end
       end
@@ -127,7 +125,6 @@ module Spigot
           login     :username
           options do
             primary_key :username
-            foreign_key :login
           end
         end
       end
@@ -138,12 +135,11 @@ module Spigot
         Spigot.define do
           service :github do
             resource :user do
-              self.instance_eval(&block)
+              instance_eval(&block)
             end
           end
         end
       end
-
     end
   end
 end

data/spec/spec_helper.rb

@@ -5,21 +5,28 @@ require 'rspec'
 require 'spigot'
 require 'hashie'
 require 'active_record'
-require "test/unit"
-require "mocha/setup"
 
-%w(fixtures support).each do |dir|
-  Dir[File.join(Spigot.root, "spec/#{dir}/**/*.rb")].each {|f| require f}
-end
+require File.join(Spigot.root, 'script/active_record.rb')
+Dir[File.join(Spigot.root, 'spec/fixtures/**/*.rb')].each { |f| require f }
 
 # Mocked Classes
-User = Class.new(Hashie::Mash)
+User = Class.new(Hashie::Mash) do
+  include Spigot::Base
+end
 Post = Class.new(Hashie::Mash)
 
 class ActiveUser < ActiveRecord::Base
   include Spigot::Base
 end
 
+class Event < ActiveRecord::Base
+  include Spigot::Base
+end
+
+class Profile < ActiveRecord::Base
+  include Spigot::Base
+end
+
 module Wrapper
   Post = Class.new(Hashie::Mash)
 end

data/spec/spigot/active_record_spec.rb

@@ -1,16 +1,23 @@
 require 'spec_helper'
 
 describe Spigot::ActiveRecord do
-  let(:subject){ActiveUser}
-  let(:data){ Spigot::Data::ActiveUser.basic.merge(id: '987') }
-  let(:user){ subject.create(name: 'Dean Martin', username: 'classyasfuck') }
+  let(:subject) { ActiveUser }
+  let(:data) { Spigot::Data::ActiveUser.basic.merge(id: '987') }
+  let(:user) { subject.create(name: 'Dean Martin', username: 'classyasfuck') }
 
   context 'with invalid mapping' do
     it 'requires the primary key to be accurate' do
       expect {
-        subject.find_by_api({full_name: 'Dean Martin'})
+        subject.find_by_api(full_name: 'Dean Martin')
       }.to raise_error(Spigot::MissingResourceError)
     end
+
+    it 'requires valid primary_keys' do
+      Spigot::Mapping::ActiveUser.invalid_primary_key
+      expect {
+        subject.find_by_api(github: { full_name: 'Dean Martin' })
+      }.to raise_error(Spigot::InvalidSchemaError)
+    end
   end
 
   context 'with valid mapping' do
@@ -38,7 +45,7 @@ describe Spigot::ActiveRecord do
     end
 
     context '#create_by_api' do
-      before{ Spigot::Mapping::ActiveUser.with_options }
+      before { Spigot::Mapping::ActiveUser.with_options }
       it 'creates a record' do
         record = subject.create_by_api(github: data)
         record.id.should_not be_nil

data/spec/spigot/base_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 describe Spigot::Base do
-  let(:data){Spigot::Data::User.basic}
-  before{ Spigot::Mapping::ActiveUser.stub }
+  let(:data) { Spigot::Data::User.basic }
+  before { Spigot::Mapping::ActiveUser.stub }
 
   context '#new_by_api' do
     it 'instantiates a record' do
@@ -11,18 +11,6 @@ describe Spigot::Base do
     end
   end
 
-  context '#formatted_api_data' do
-    it 'calls format on the translator' do
-      Spigot::Translator.any_instance.should_receive(:format)
-      ActiveUser.formatted_api_data(github: data)
-    end
-
-    it 'returns formatted data' do
-      Spigot::Translator.any_instance.should_receive(:format)
-      formatted = ActiveUser.formatted_api_data(github: data)
-    end
-  end
-
   context '#spigot' do
     it 'returns a spigot proxy' do
       ActiveUser.spigot(:github).should be_a_kind_of(Spigot::Proxy)

data/spec/spigot/configuration_spec.rb

@@ -8,24 +8,24 @@ describe Spigot::Configuration do
   end
 
   context 'access' do
-    it "is callable from .configure" do
+    it 'is callable from .configure' do
       Spigot.configure do |c|
         expect(c).to be_kind_of(Spigot::Configuration)
       end
     end
 
     context 'options' do
-      let(:map){{'user' => {a: 1}}}
-      let(:options_key){'my_special_key'}
+      let(:map) { { 'user' => { a: 1 } } }
+      let(:options_key) { 'my_special_key' }
 
-      it "is able to set the options_key" do
-        Spigot.configure{|config| config.options_key = options_key }
+      it 'is able to set the options_key' do
+        Spigot.configure { |config| config.options_key = options_key }
         expect(Spigot.config.options_key).to eq(options_key)
       end
 
-      it "is able to set the logger" do
+      it 'is able to set the logger' do
         logger = Logger.new(STDOUT)
-        Spigot.configure{|config| config.logger = logger }
+        Spigot.configure { |config| config.logger = logger }
         expect(Spigot.config.logger).to eq(logger)
       end
     end

data/spec/spigot/map/base_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 describe Spigot::Map::Base do
-  let(:subject){Spigot::Map::Base.new}
-  let(:service){Spigot::Map::Service.new(:github)}
+  let(:subject) { Spigot::Map::Base.new }
+  let(:service) { Spigot::Map::Service.new(:github) }
 
   context '#initialize' do
     it 'initializes a services array' do
@@ -10,10 +10,16 @@ describe Spigot::Map::Base do
     end
   end
 
+  context '#inspect' do
+    it 'returns a string' do
+      subject.inspect.should match(/Spigot::Map::Base/)
+    end
+  end
+
   context '.define' do
     it 'accepts a block' do
       Spigot::Map::Service.should_receive(:class_eval)
-      subject.define{'foo'}
+      subject.define { 'foo' }
     end
 
     it 'does not require a block' do
@@ -48,8 +54,8 @@ describe Spigot::Map::Base do
     end
 
     it 'allows multiple updates' do
-      subject.define{ service(:github) }
-      subject.define{ service(:twitter) }
+      subject.define { service(:github) }
+      subject.define { service(:twitter) }
 
       subject.services.length.should eq(2)
     end
@@ -72,7 +78,7 @@ describe Spigot::Map::Base do
   context '.to_hash' do
     it 'returns a hash of current services' do
       subject.update(:github, service)
-      subject.to_hash.should eq({github: {}})
+      subject.to_hash.should eq(github: {})
     end
   end