omniauth-clio 0.0.12 → 0.0.13

data/README.md

@@ -14,28 +14,43 @@ You can pull them in directly from github e.g.:
 
     gem 'omniauth-clio', :git => 'https://github.com/shicholas/omniauth-clio.git'
 
-Once these are in, you need to add the following to your `config/initializers/omniauth.rb`:
+Once these are in, you need to add the following to your `config/initializers/omniauth.rb` if using a rails app:
 
     Rails.application.config.middleware.use OmniAuth::Builder do
-      provider :clio, "consumer_key", "consumer_secret" 
+      provider :clio, ENV['client_key'], ENV['client_secret'] 
     end
 
-You will obviously have to put in your key and secret, which you get when you register your app with clio (they call them API Key and Secret Key). 
+If you are using Devise in conjunction with omniauth, add this to your devise.rb file that is generated by devise:
+
+	config.omniauth :clio, ENV['client_key'], ENV['client_secret']
+
+
+If you're just using something else that doesn't depend on Rack you can add this:
+	use OmniAuth::Builder do
+  		provider :cheddar, ENV['client_key'], ENV['client_secret']
+	end
 
 
 ## Watch the RailsCast
 
-Ryan Bates has put together an excellent RailsCast on OmniAuth:
+Ryan Bates has put together an excellent RailsCast on OmniAuth which you can watch here: http://railscasts.com/episodes/241-simple-omniauth-revised
+
+## Getting your API Key
+To get an API Key from Clio you will need to follow these steps http://api-docs.goclio.com/v1/index.html#create-a-clio-account.
+
+It is recommended you use environment variables to store your keys so that Clio can regonize your app. You can do so by using these shell commands:
+export CLIO_CLIENT_KEY=...
+export CLIO_CLIENT_SECRET=...
+rails server
 
-[![RailsCast #241](https://www.evernote.com/shard/s35/sh/479f2503-aefa-4542-a7b4-8f84fd22eafc/0571f5a3795a0be3d0b0814312a8d5b7/res/49b5478a-657c-4aff-ae58-dae08b9a46d5/Screen_Shot_2012-07-15_at_12.41.15_PM-20120715-125424.jpg.jpg "RailsCast #241 - Simple OmniAuth (revised)")](http://railscasts.com/episodes/241-simple-omniauth-revised)
+If you love Heroku as much as I do, you can use these commands to get it to work there:
+heroku config:add CLIO_APP_KEY=...
 
 
 ## Supported Rubies
 
-OmniAuth clio is tested under 1.8.7, 1.9.2, 1.9.3 and Ruby Enterprise Edition.
+OmniAuth clio is tested under 1.8.7, 1.9.2, 1.9.3 and Ruby Enterprise Edition. I used the simplecov gem, https://github.com/colszowka/simplecov, to help me determine this.
 
-[![CI Build
-Status](https://secure.travis-ci.org/arunagw/omniauth-clio.png)](http://travis-ci.org/arunagw/omniauth-clio)
 
 ## Note on Patches/Pull Requests
 
@@ -43,11 +58,11 @@ Status](https://secure.travis-ci.org/arunagw/omniauth-clio.png)](http://travis-c
 - Make your feature addition or bug fix.
 - Add tests for it. This is important so I don’t break it in a future version unintentionally.
 - Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-- Send me a pull request. Bonus points for topic branches.
+- Send me a pull request, thanks so much for your help!!
 
 ## License
 
-Copyright (c) 2011 by Nicholas Shook
+Copyright (c) 2012 by Nicholas Shook
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/lib/omniauth-clio/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Clio
-    VERSION = "0.0.12"
+    VERSION = "0.0.13"
   end
 end

data/lib/omniauth/strategies/Clio.rb

@@ -1,68 +1,39 @@
-require 'omniauth-oauth'
-require 'multi_json'
+require 'omniauth-oauth2'
+# require 'multi_json'
 
 module OmniAuth
   module Strategies
-    class Clio < OmniAuth::Strategies::OAuth
-      option :name, 'clio'
-      option :client_options, {:authorize_path => '/oauth/authenticate',
-                               :site => 'http://api-docs.goclio.com/',
-										 :proxy => ENV['http_proxy'] ? URI(ENV['http_proxy']) : nil}
-
-      uid { access_token.params[:user_id] }
-
-      info do
-        {
-          :nickname => raw_info['screen_name'],
-          :name => raw_info['name'],
-          :location => raw_info['location'],
-          :image => raw_info['profile_image_url'],
-          :description => raw_info['description'],
-          :urls => {
-            'Website' => raw_info['url'],
-            'clio' => 'http://goclio.com/' + raw_info['screen_name'],
-          }
-        }
-      end
-
-      extra do
-        { :raw_info => raw_info }
-      end
-
-      def raw_info
-        @raw_info ||= MultiJson.load(access_token.get('/1/account/verify_credentials.json').body)
-      rescue ::Errno::ETIMEDOUT
-        raise ::Timeout::Error
+    class Clio < OmniAuth::Strategies::OAuth2
+      option :name, "Clio"
+
+      option :client_options, {
+        :site => 'https://app.goclio.com',
+        :authorize_url => '/oauth/authorize',
+        :token_url => '/oauth/access_token'
+      }
+      
+      def authorize_params
+        super.tap do |params|
+          params[:response_type] = "code"
+          params[:client_id] = client.id
+          params[:redirect_uri] ||= callback_url
+        end
       end
 
-      alias :old_request_phase :request_phase
-
       def request_phase
-        force_login = session['omniauth.params'] ? session['omniauth.params']['force_login'] : nil
-        screen_name = session['omniauth.params'] ? session['omniauth.params']['screen_name'] : nil
-        x_auth_access_type = session['omniauth.params'] ? session['omniauth.params']['x_auth_access_type'] : nil
-        if force_login && !force_login.empty?
-          options[:authorize_params] ||= {}
-          options[:authorize_params].merge!(:force_login => 'true')
-        end
-        if screen_name && !screen_name.empty?
-          options[:authorize_params] ||= {}
-          options[:authorize_params].merge!(:force_login => 'true', :screen_name => screen_name)
-        end
-        if x_auth_access_type
-          options[:request_params] || {}
-          options[:request_params].merge!(:x_auth_access_type => x_auth_access_type)
-        end
-
-        if session['omniauth.params'] && session['omniauth.params']["use_authorize"] == "true"
-          options.client_options.authorize_path = '/oauth/authorize'
-        else
-          options.client_options.authorize_path = '/oauth/authenticate'
-        end
-        
-        old_request_phase
+        super
       end
 
+      def build_access_token
+        token_params = {
+          :code => request.params['code'],
+          :redirect_uri => callback_url,
+          :client_id => client.id,
+          :client_secret => client.secret,
+          :grant_type => 'authorization_code'
+        }
+        client.get_token(token_params)
+      end
     end
   end
 end

data/omniauth-clio.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'multi_json', '~> 1.3'
-  s.add_runtime_dependency 'omniauth-oauth', '~> 1.0'
+  # s.add_dependency 'multi_json', '~> 1.3'
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.0'
   s.add_development_dependency 'rspec', '~> 2.7'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'simplecov'

data/spec/omniauth/strategies/clio_spec.rb

@@ -1,21 +1,18 @@
 require 'spec_helper'
 
-describe OmniAuth::Strategies::clio do
+describe OmniAuth::Strategies::Clio do
   subject do
-    OmniAuth::Strategies::clio.new({})
+    OmniAuth::Strategies::Clio.new({})
   end
 
   context "client options" do
     it 'should have correct name' do
-      subject.options.name.should eq("clio")
+      subject.options.name.should eq("Clio")
     end
 
     it 'should have correct site' do
-      subject.options.client_options.site.should eq('http://api-docs.goclio.com')
+      subject.options.client_options.site.should eq('https://app.goclio.com')
     end
 
-    it 'should have correct authorize url' do
-      subject.options.client_options.authorize_path.should eq('/oauth/authenticate')
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-clio
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,26 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-02 00:00:00.000000000 Z
+date: 2012-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: omniauth-oauth
+  name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -114,6 +98,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .DS_Store
 - .gitignore
 - .rspec
 - .travis.yml