copies_omniauth 0.0.9

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+gemspec
+gem 'rails'
+group :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'sqlite3'
+end

data/README.markdown

@@ -0,0 +1,81 @@
+![OmniAuth Image](http://blog.deanbrundage.com/wp-content/uploads/2012/01/copies_omniauth.png)
+
+A small gem for copying [OmniAuth](https://github.com/intridea/omniauth "OmniAuth") information into models
+
+# Usage #
+
+    class FacebookProfile
+      include CopiesOmniauth
+
+      attr_accessor :email
+      attr_accessor :first_name
+      attr_accessor :last_name
+      attr_accessor :token
+      attr_accessor :uid
+    
+      copies_omniauth :attributes => { :email => %w(info email),
+                                       :first_name => %w(info first_name),
+                                       :last_name => %w(info last_name)
+                                     }
+    end
+    
+    f = FacebookProfile.new_from_omniauth(omniauth)
+
+## Arguments ##
+
+The `copies_omniauth` method takes a hash with two keys `:options` and `:attributes`
+
+### Options ###
+
+ * `:overwrite` Always overwrite information (default: *true*)
+ * `:secret_attribute` The attribute on the class used to store OmniAuth's secret (default: *:secret*)
+ * `:skip_provider_check` Do not verify the OmniAuth provider matches the model (default: *false*)
+ * `:token_attribute` The attribute on the class used to store OmniAuth's token (default: *:token*)
+ * `:uid_attribute` The attribute on an instance used to store OmniAuth's uid (default: *:uid*)
+ * `:provider_name` CopiesOmniauth will guess the expected OmniAuth provider from the class name by chopping "Provider" off the end of the name.  To override this behavior, set the `:provider_name` option.
+
+### Attributes ###
+
+**Copies OmniAuth always copies `secret`, `token`, and `uid` if setters are present on the model.**
+
+The `:attributes` parameter tells CopiesOmniauth which attributes to set on an instance and how to find their values in the OmniAuth hash.  Keys of the parameter represent instance attributes and their values represent a path in the OmniAuth hash.  Given the following OmniAuth hash:
+
+    { "provider" => "twitter",
+      "uid"      => "10223402",
+      "info"     => { "name" => "Dean Brundage",
+                      "email" => "dean@deanbrundage.com",
+                      "nickname" => "brundage",
+                      "urls" => [ "blog" => "http://blog.deanbrundage.com" ]
+                      ....
+                    }
+     "credentials" => { "token" => "....",
+                        "secret" => "....",
+                        ....
+                      }
+    }
+
+And given a model:
+
+    class TwitterProfile
+      attr_accessor :real_name
+    end
+
+To copy the "name" attribute into your model's "real_name" attribute:
+
+    copies_omniauth :attributes => { :real_name => ["info", "name"] }
+
+This traverses the OmniAuth hash, sending _info_, then _name_ and stores the value in the model's `real_name` attribute
+
+# Methods #
+
+## Class Methods ##
+
+`copies_omniauth` Configuration macro
+
+`new_from_omniauth(omniauth_hash)` Calls `new`, then `copy_from_omniauth(omniauth_hash)`
+
+`create_from_omniauth(omniauth_hash)` Calls `new_from_omniauth(omniauth_hash)` then `save` -- useful for `ActiveRecord` models
+
+## Instance Methods ##
+
+`copy_from_omniauth(omniauth_hash)` Copies values from `omniauth_hash` into the instance

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "./spec/specs/*_spec.rb"
+end
+

data/lib/copies_omniauth.rb

@@ -0,0 +1,157 @@
+require 'copies_omniauth/version'
+
+module CopiesOmniauth
+
+  SECRET_KEY = ["credentials","secret"]
+  TOKEN_KEY = ["credentials","token"]
+  UID_KEY = "uid"
+
+  class ProviderNameMismatch < RuntimeError; end
+  class UidMismatch < RuntimeError; end
+
+
+  if defined?(Rails)
+    require 'copies_omniauth/railtie'
+  end
+
+
+  def self.included(parent)
+    parent.extend ClassMethods
+  end
+
+
+  module ClassMethods
+
+    def copies_omniauth(args={})
+      options = self.class_variable_set( :@@copies_omniauth_options,
+                                           { :overwrite        => true,
+                                             :provider_name => self.name.sub("Profile","").downcase,
+                                             :secret_attribute => :secret,
+                                             :skip_provider_check => false,
+                                             :token_attribute  => :token,
+                                             :uid_attribute    => :uid
+                                           })
+      unless args[:options].nil?
+        options.merge!(args[:options])
+      end
+
+      attributes = self.class_variable_set( :@@copies_omniauth_attributes,
+                                       { options[:secret_attribute] => SECRET_KEY,
+                                         options[:token_attribute] => TOKEN_KEY,
+                                         options[:uid_attribute]   => UID_KEY
+                                       })
+      unless args[:attributes].nil?
+        attributes.merge!(args[:attributes])
+      end
+
+      [ options[:secret_attribute],
+        options[:token_attribute],
+        options[:uid_attribute] ].each do |attr|
+        attributes.delete(attr) unless instance_has_setter_for?(attr)
+      end
+
+      attributes.each do |attr,omniauth_key|
+        case omniauth_key
+        when Array, String, Symbol
+        else
+          raise ArgumentError, "Don't know how to traverse OmniAuth with #{omniauth_key}"
+        end
+      end
+      include CopiesOmniauth::InstanceMethods
+    end
+
+
+    def create_from_omniauth(omniauth)
+      new_from_omniauth(omniauth).save
+    end
+
+
+    def new_from_omniauth(omniauth)
+      new().copy_from_omniauth(omniauth)
+    end
+
+
+  private
+
+    def attribute_setter_for?(attr)
+      respond_to?(:attribute_method?) && attribute_method?(attr)
+    end
+
+
+    def instance_has_setter_for?(attr)
+      attribute_setter_for?(attr) || method_setter_for?(attr)
+    end
+
+
+    def method_setter_for?(attr)
+      instance_methods.include?("#{attr}=".to_sym)
+    end
+
+  end
+
+
+  module InstanceMethods
+
+    def copy_from_omniauth(omniauth)
+
+      validate_provider omniauth["provider"]
+      validate_uid      omniauth["uid"]
+
+      copies_omniauth_attributes.each do |attr,omniauth_key|
+
+        case omniauth_key
+        when Array
+        value = omniauth_key.inject(omniauth) do |hash,key|
+                                                hash[key] unless hash.nil?
+                                              end
+        when String
+          value = omniauth[omniauth_key]
+
+        when Symbol
+          value = omniauth[omniauth_key.to_s]
+
+        end
+
+        if copies_omniauth_options[:overwrite] || send(attr).nil?
+          self.send("#{attr}=",value)
+        end
+      end
+      self
+    end
+
+  private
+
+    def copies_omniauth_attributes
+     self.class.class_variable_get(:@@copies_omniauth_attributes)
+    end
+
+
+    def copies_omniauth_options
+     self.class.class_variable_get(:@@copies_omniauth_options)
+    end
+
+
+    def omniauth_uid
+      if respond_to?(copies_omniauth_options[:uid_attribute])
+        send(copies_omniauth_options[:uid_attribute])
+      end
+    end
+
+
+    def validate_provider(provider)
+      return if copies_omniauth_options[:skip_provider_check]
+      unless provider == copies_omniauth_options[:provider_name].to_s
+        raise ProviderNameMismatch, "OmniAuth (#{provider}) does not represent a #{copies_omniauth_options[:provider_name]} profile."
+      end
+    end
+
+
+    def validate_uid(uid)
+      if ! omniauth_uid.nil? && uid != omniauth_uid
+        raise UidMismatch, "OmniAuth (#{uid}) does not apply to this #{copies_omniauth_options[:provider_name]} profile (#{omniauth_uid})."
+      end
+    end
+
+  end
+
+end

data/lib/copies_omniauth/railtie.rb

@@ -0,0 +1,13 @@
+require 'copies_omniauth'
+require 'rails'
+module CopiesOmniauth
+  class Railtie < Rails::Railtie
+
+    initializer "active_record.copies_omniauth" do |app|
+      ActiveSupport.on_load :active_record do
+        include CopiesOmniauth
+      end
+    end
+
+  end
+end

data/lib/copies_omniauth/version.rb

@@ -0,0 +1,3 @@
+module CopiesOmniauth
+  VERSION = '0.0.9'
+end

data/spec/db/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/spec/db/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :active_record_profiles, :force => true do |t|
+    t.string :name, :null => false
+    t.string :uid, :null => false
+    t.string :token, :null => false
+  end
+
+end

data/spec/models/active_record_profile.rb

@@ -0,0 +1,3 @@
+class ActiveRecordProfile < ActiveRecord::Base
+#  copies_omniauth
+end

data/spec/models/dummy_profile.rb

@@ -0,0 +1,7 @@
+class DummyProfile
+  include CopiesOmniauth
+  attr_accessor :name
+  attr_accessor :token
+  attr_accessor :uid
+  copies_omniauth :attributes => { :name => %w(info name) }
+end

data/spec/models/nodefaults_profile.rb

@@ -0,0 +1,4 @@
+class NodefaultsProfile
+  include CopiesOmniauth
+  copies_omniauth
+end

data/spec/models/nonstandard_info.rb

@@ -0,0 +1,12 @@
+class NonstandardInfo
+  include CopiesOmniauth
+  attr_accessor :ident
+  attr_accessor :provider_uid
+  attr_accessor :name
+
+  copies_omniauth( :attributes => { :name => %w(info name) },
+                   :options => { :provider_name => :irregular,
+                                 :token_attribute => :ident,
+                                 :uid_attribute => :provider_uid
+                               })
+end

data/spec/omniauths.yml

@@ -0,0 +1,27 @@
+:dummy:
+  provider: "dummy"
+  uid: 1
+  info:
+    name: "A Dummy Profile"
+  credentials:
+    token: "blue"
+
+:error:
+  provider: "error"
+  uid: 1
+  credentials:
+    token: "blue"
+
+:irregular:
+  provider: "irregular"
+  uid: 1
+  info:
+    name: "An Irregular Profile"
+  credentials:
+    token: "blue"
+
+:nodefaults:
+  provider: "nodefaults"
+  uid: 1
+  credentials:
+    token: "blue"

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+rspec_dir = File.dirname(__FILE__)
+
+ENV["RAILS_ENV"] ||= "test"
+
+require 'rails/all'
+require 'copies_omniauth'
+
+ActiveRecord::Base.configurations = YAML::load(File.open(File.join(rspec_dir, "/db", "database.yml")))
+ActiveRecord::Base.establish_connection(ENV["DB"] || "test")
+ActiveRecord::Base.logger = Logger.new(File.join(rspec_dir, "debug.log"))
+ActiveRecord::Migration.verbose = false
+load(File.join(rspec_dir, "db", "schema.rb"))
+
+#ActiveSupport.run_load_hooks(:active_record, ActiveRecord::Base)
+
+OMNIAUTHS = YAML::load(File.open(File.join(rspec_dir, "omniauths.yml")))
+
+Dir[File.join(rspec_dir,"models","*.rb")].each { |f| require f }

data/spec/specs/custom_behavior_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe CopiesOmniauth, 'custom behavior' do
+
+  it "copies the uid by default" do
+    profile = NonstandardInfo.new
+    profile.provider_uid.should be_nil
+    profile.copy_from_omniauth OMNIAUTHS[:irregular]
+    profile.provider_uid.should_not be_nil
+    profile.provider_uid.should eq OMNIAUTHS[:irregular]["uid"]
+  end
+
+
+  it "copies the token by default" do
+    profile = NonstandardInfo.new
+    profile.ident.should be_nil
+    profile.copy_from_omniauth OMNIAUTHS[:irregular]
+    profile.ident.should_not be_nil
+    profile.ident.should eq OMNIAUTHS[:irregular]["credentials"]["token"]
+  end
+
+
+  it "copies omniauth values requested" do
+    profile = NonstandardInfo.new
+    profile.name.should be_nil
+    profile.copy_from_omniauth OMNIAUTHS[:irregular]
+    profile.name.should_not be_nil
+    profile.name.should eq OMNIAUTHS[:irregular]["info"]["name"]
+  end
+
+end

data/spec/specs/default_behavior_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe CopiesOmniauth, 'default behavior' do
+
+  it "returns self" do
+    profile = DummyProfile.new
+    profile.copy_from_omniauth(OMNIAUTHS[:dummy]).should === profile
+  end
+
+
+  it "copies the uid by default" do
+    profile = DummyProfile.new
+    profile.uid.should be_nil
+    profile.copy_from_omniauth OMNIAUTHS[:dummy]
+    profile.uid.should_not be_nil
+    profile.uid.should eq OMNIAUTHS[:dummy]["uid"]
+  end
+
+
+  it "does not try to copy the uid if the class doesn't have one" do
+    profile = NodefaultsProfile.new
+    profile.should_not respond_to(:uid)
+    expect {
+      profile.copy_from_omniauth OMNIAUTHS[:nodefaults]
+    }.not_to raise_error
+  end
+
+
+  it "copies the token by default" do
+    profile = DummyProfile.new
+    profile.token.should be_nil
+    profile.copy_from_omniauth OMNIAUTHS[:dummy]
+    profile.token.should_not be_nil
+    profile.token.should eq OMNIAUTHS[:dummy]["credentials"]["token"]
+  end
+
+
+  it "does not try to copy the token if the class doesn't have one" do
+    profile = NodefaultsProfile.new
+    profile.should_not respond_to(:token)
+    expect {
+      profile.copy_from_omniauth OMNIAUTHS[:nodefaults]
+    }.not_to raise_error
+  end
+
+
+  it "copies omniauth values requested" do
+    profile = DummyProfile.new
+    profile.name.should be_nil
+    profile.copy_from_omniauth OMNIAUTHS[:dummy]
+    profile.name.should_not be_nil
+    profile.name.should eq OMNIAUTHS[:dummy]["info"]["name"]
+  end
+
+
+  it "doesn't overwrite values when configured not to" do
+    name = "Blark"
+    name.should_not eq OMNIAUTHS[:dummy]["info"]["name"]
+    class DummyProfile
+      copies_omniauth(:attributes => {:name => %w(info name)},
+                      :options => {:overwrite => false})
+    end
+    profile = DummyProfile.new
+    profile.name = name
+    profile.copy_from_omniauth OMNIAUTHS[:dummy]
+    profile.name.should eq name
+  end
+
+end

data/spec/specs/errors_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe CopiesOmniauth, 'exceptions' do
+
+  it "raises an error when the omniauth information does not represent the class" do
+    profile = DummyProfile.new
+    expect {
+      profile.copy_from_omniauth(OMNIAUTHS[:irregular])
+    }.to raise_error(CopiesOmniauth::ProviderNameMismatch)
+  end
+
+
+  it "raises an error if the omniauth uid does not match the model's uid" do
+    profile = DummyProfile.new
+    profile.uid = 2
+    profile.uid.should_not eq OMNIAUTHS[:dummy]["uid"]
+    expect {
+      profile.copy_from_omniauth(OMNIAUTHS[:dummy])
+    }.to raise_error(CopiesOmniauth::UidMismatch)
+  end
+
+
+  it "raises an error when the class doesn't have a setter for an attribute" do
+    class ErrorProfile
+      include CopiesOmniauth
+      copies_omniauth :attributes => { :no_setter_for_this => :p }
+    end
+    expect {
+      ErrorProfile.new.copy_from_omniauth(OMNIAUTHS[:error])
+    }.to raise_error(NoMethodError)
+  end
+
+
+  it "raises an error when given bad attribute traversal" do
+    expect {
+      class ErrorProfile
+        include CopiesOmniauth
+        copies_omniauth :attributes => { :bad_girl => {} }
+      end
+    }.to raise_error(ArgumentError)
+  end
+
+end

data/spec/specs/methods_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe CopiesOmniauth, 'methods' do
+
+  it "adds methods to a plain class" do
+    DummyProfile.should respond_to(:copies_omniauth)
+  end
+
+
+  it "adds instance methods to a plain class" do
+    DummyProfile.new.should respond_to(:copy_from_omniauth)
+  end
+
+
+  it "adds methods to ActiveRecord" do
+    ActiveRecord::Base.should respond_to(:copies_omniauth)
+  end
+
+
+  it "adds instance methods to ActiveRecord" do
+    ActiveRecordProfile.new.should respond_to(:copy_from_omniauth)
+  end
+
+end

data/spec/specs/version_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe CopiesOmniauth, 'VERSION' do
+  it 'is present' do
+    CopiesOmniauth::VERSION.should_not be_nil
+  end
+
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: copies_omniauth
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+  prerelease: 
+platform: ruby
+authors:
+- Dean Brundage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email: dean@deanbrundage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/copies_omniauth.rb
+- lib/copies_omniauth/railtie.rb
+- lib/copies_omniauth/version.rb
+- Gemfile
+- Rakefile
+- README.markdown
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/models/active_record_profile.rb
+- spec/models/dummy_profile.rb
+- spec/models/nodefaults_profile.rb
+- spec/models/nonstandard_info.rb
+- spec/omniauths.yml
+- spec/spec_helper.rb
+- spec/specs/custom_behavior_spec.rb
+- spec/specs/default_behavior_spec.rb
+- spec/specs/errors_spec.rb
+- spec/specs/methods_spec.rb
+- spec/specs/version_spec.rb
+homepage: https://github.com/brundage/copies_omniauth
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Utility for copying information from OmniAuth into other models
+test_files:
+- spec/db/database.yml
+- spec/db/schema.rb
+- spec/models/active_record_profile.rb
+- spec/models/dummy_profile.rb
+- spec/models/nodefaults_profile.rb
+- spec/models/nonstandard_info.rb
+- spec/omniauths.yml
+- spec/spec_helper.rb
+- spec/specs/custom_behavior_spec.rb
+- spec/specs/default_behavior_spec.rb
+- spec/specs/errors_spec.rb
+- spec/specs/methods_spec.rb
+- spec/specs/version_spec.rb
+has_rdoc: