goodguide-accounts 1.0.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+gem 'oauth2', :git => 'git://github.com/jayferd/oauth2',
+              :ref => 'master'
+gem 'api_smith'
+gem 'activesupport', :require => 'active_support'
+gemspec

data/goodguide-accounts.gemspec

@@ -0,0 +1,16 @@
+require './lib/goodguide/accounts/version'
+
+Gem::Specification.new do |s|
+  s.name = "goodguide-accounts"
+  s.version = GoodGuide::Accounts::VERSION
+  s.authors = ["Jay Adkisson", "Ryan Aipperspach"]
+  s.email = ["jay@goodguide.com", "ryan@goodguide.com"]
+  s.summary = "GoodGuide Accounts API gem"
+  s.description = "Gem to access the GoodGuide Accounts API"
+  s.homepage = "http://www.goodguide.com"
+  s.rubyforge_project = "goodguide"
+  s.files = Dir['Gemfile', 'goodguide-accounts.gemspec', 'lib/**/*.rb']
+
+  s.add_dependency('oauth2', '~> 0.5.0.rc1')
+  s.add_dependency('i18n')
+end

data/lib/goodguide/accounts/base.rb

@@ -0,0 +1,264 @@
+require File.expand_path('issue_preferences', File.dirname(__FILE__))
+
+module GoodGuide
+  module Accounts
+    class Base
+      include IssuePreferences
+      include Profile
+
+      NotAuthenticatedError = Class.new(StandardError)
+
+      class << self
+        #####
+        # How the auth flow works:
+        #
+        # 1.  Redirect the user-agent to Account.authorize_url
+        # 2.  After authentication, the user will be redirected
+        #     to your pre-configured authorization endpoint,
+        #     (e.g. /sessions/authorize), with ?code=...
+        # 3.  Do something like this:
+        #
+        #       def authorize
+        #         # get the code from the params
+        #         code = params[:code]
+        #         # exchange it with the oauth2 server for an
+        #         # access token
+        #         credentials = User.authorize(code)
+        #         # store credentials
+        #         # (a hash of access_token, refresh_token, and expires_at)
+        #         # in the session
+        #         session[:credentials] = credentials
+        #         # and send them on their way
+        #         redirect_to session[:redirect] || '/'
+        #       end
+        #
+        # 4. To get the current user, do something like this:
+        #
+        #       def current_user
+        #         User.authenticate(session[:credentials])
+        #       end
+        def authenticate(credentials, opts={})
+          new({:credentials => credentials}.merge(opts))
+        end
+
+        # returns a credentials hash
+        # given an authorization code
+        def authorize(code, options={})
+          access_token = client.auth_code.get_token(code, {
+            :redirect_uri => config[:redirect_uri]
+          }.merge(options))
+
+          # return a credentials hash
+          {
+            :access_token => access_token.token,
+            :refresh_token => access_token.refresh_token,
+            :expires_at => access_token.expires_at
+          }
+        end
+
+        def authorize_url(opts={})
+          client.auth_code.authorize_url(opts)
+        end
+
+        def logout_url(opts={})
+          url = config[:site] + "/sessions/clear"
+          url += "?redirect=#{CGI.escape(opts[:redirect])}" if opts[:redirect]
+          url
+        end
+
+        def config=(conf)
+          # In the absence of #symbolize_keys...
+          conf = conf.dup
+          conf.keys.each do |k|
+            conf[k.to_sym] = conf.delete(k)
+          end
+
+          @config = default_config.merge(conf)
+        end
+
+        def config
+          return @config if instance_variable_defined? :@config
+
+          yaml = YAML.load_file('config/goodguide_accounts.yml')
+
+          self.config = env && yaml.key?(env) ? yaml[env] : yaml
+
+          @config
+        end
+
+        def client
+          @client ||= begin
+            my_config = config.dup
+
+            if my_config[:site]
+              my_config[:site] += '/api/account'
+            end
+
+            OAuth2::Client.new(
+              my_config.delete(:identifier), my_config.delete(:secret),
+              my_config.merge(:ssl => {:verify => false})
+            )
+          end
+        end
+
+      private
+        def default_config
+          {
+            :authorize_url => '/oauth2/authorize',
+            :token_url => '/oauth2/token',
+            :site => 'https://accounts.goodguide.com'
+          }
+        end
+
+        def env
+          return @env if instance_variable_defined? :@env
+
+          @env = ENV['ACCOUNTS_ENV'] || if defined?(Rails) and Rails.respond_to? :env
+            Rails.env
+          elsif defined?(RAILS_ENV)
+            RAILS_ENV
+          end
+        end
+      end
+
+      attr_reader :client
+      attr_reader :access_token
+      attr_reader :refresh_token
+      attr_reader :id
+      def initialize(opts={})
+        opts = opts.dup
+
+        credentials = opts.delete(:credentials) || {}
+        @expires_at    = credentials[:expires_at]
+        @access_token  = credentials[:access_token]
+        @refresh_token = credentials[:refresh_token]
+
+        opts.each do |k, v|
+          instance_variable_set("@#{k}", v)
+        end
+      end
+
+      def update_credentials(opts = {})
+        @expires_at = opts[:expires_at]
+        @access_token = opts[:access_token]
+        @refresh_token = opts[:refresh_token]
+
+        self
+      end
+
+      def base_body_options
+        opts = {}
+        opts[:bearer_token] = access_token if authorized?
+        opts
+      end
+
+      def refreshable?
+        refresh_token
+      end
+
+      def authorized?
+        authenticated? or refreshable?
+      end
+
+      def authenticated?
+        !!(access_token and not expired?)
+      end
+
+      def profile?
+        profile.present?
+      end
+
+      def guest?
+        not authorized? #and not profile?
+      end
+
+      def real?
+        not guest?
+      end
+
+      def needs_refresh?
+        authorized? and not authenticated?
+      end
+
+      def expires_at
+        Time.at(@expires_at || 0)
+      end
+
+      def expires_in
+        (expires_at - Time.now).to_i
+      end
+
+      def expired?
+        expires_in <= 0
+      end
+
+      def endpoint
+        if authorized?
+          '/account'
+        elsif profile?
+          "/accounts/#{id}"
+        end
+      end
+
+      def credentials
+        {
+          :expires_at => expires_at,
+          :access_token => access_token,
+          :refresh_token => refresh_token
+        }
+      end
+
+      def refresh!
+        if refreshable?
+          @connection = connection.refresh!
+          update_credentials(
+            :expires_at => connection.expires_at,
+            :refresh_token => connection.refresh_token,
+            :access_token => connection.token
+          )
+        end
+      rescue OAuth2::Error
+        $!.response
+      end
+
+      def connection
+        @connection ||= begin
+          if authorized?
+            OAuth2::AccessToken.new(self.class.client, access_token, credentials)
+          else
+            self.class.client
+          end
+        end
+      end
+
+      def endpoint
+        if authorized?
+          '/api/account'
+        else
+          "/api/accounts/#{id}"
+        end
+      end
+
+      # delegate http methods to the connection
+      %w(get put post delete head).each do |verb|
+        define_method(verb) do |*args|
+          request(verb, *args)
+        end
+      end
+
+      def request(verb, path, opts={})
+        path = "/#{path}" if path.is_a? Symbol
+
+        unless opts.key?(:body) || opts.key?(:headers)
+          opts = { :body => opts }
+        end
+
+        JSON.load(connection.request(verb.to_sym, endpoint + path, opts).body)
+      end
+
+      def profile
+        @profile ||= guest? ? {} : get('/')['account']
+      end
+    end
+  end
+end

data/lib/goodguide/accounts/issue_preferences.rb

@@ -0,0 +1,15 @@
+module GoodGuide
+  module Accounts
+    module IssuePreferences
+
+      def issue_preferences
+        @issue_preferences ||= get(:issue_preferences)['issue_preferences']
+      end
+
+      def update_issue_preferences(prefs)
+        @issue_preferences = nil
+        put(:issue_preferences, :issue_preferences => prefs)
+      end
+    end
+  end
+end

data/lib/goodguide/accounts/profile.rb

@@ -0,0 +1,47 @@
+module GoodGuide
+  module Accounts
+    module Profile
+      def with_profile(default = nil, &block)
+        profile? ? yield(profile) : default
+      end
+
+      def identifier
+        with_profile do |profile|
+          profile['identifier']
+        end
+      end
+
+      def given_name
+        with_profile do |profile|
+          name = profile["name"]["givenName"] ||
+            profile["displayName"] ||
+            profile["name"]["formatted"]
+
+          !name.blank? ? name.strip : "GoodGuide User"
+        end
+      end
+
+      def full_name
+        with_profile do |profile|
+          name = profile["name"]["formatted"]
+
+          !name.blank? ? name.strip : "GoodGuide User"
+        end
+      end
+
+      def profile_picture(size = nil)
+        with_profile do |profile|
+          photo = profile["photo"]
+          photo.gsub!("=large", "=#{size}") if facebook? and size.present?
+          photo
+        end
+      end
+
+      def facebook?
+        with_profile(false) do |profile|
+          profile["identifier"] && profile["identifier"].include?("facebook.com")
+        end
+      end
+    end
+  end
+end

data/lib/goodguide/accounts/version.rb

@@ -0,0 +1,5 @@
+module GoodGuide
+  module Accounts
+    VERSION = '1.0.0'
+  end
+end

data/lib/goodguide/accounts.rb

@@ -0,0 +1,13 @@
+require 'active_support/core_ext'
+require 'oauth2'
+
+module GoodGuide
+  module Accounts
+  end
+end
+
+require File.expand_path('../oauth2_error', File.dirname(__FILE__))
+require File.expand_path('accounts/version', File.dirname(__FILE__))
+require File.expand_path('accounts/issue_preferences', File.dirname(__FILE__))
+require File.expand_path('accounts/profile', File.dirname(__FILE__))
+require File.expand_path('accounts/base', File.dirname(__FILE__))

data/lib/oauth2_error.rb

@@ -0,0 +1,5 @@
+class OAuth2::Error
+  def message
+    @message ||= JSON.load(response.body)['error']
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: goodguide-accounts
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jay Adkisson
+- Ryan Aipperspach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth2
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.5.0.rc1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Gem to access the GoodGuide Accounts API
+email: 
+- jay@goodguide.com
+- ryan@goodguide.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- goodguide-accounts.gemspec
+- lib/goodguide/accounts/issue_preferences.rb
+- lib/goodguide/accounts/base.rb
+- lib/goodguide/accounts/profile.rb
+- lib/goodguide/accounts/version.rb
+- lib/goodguide/accounts.rb
+- lib/oauth2_error.rb
+has_rdoc: true
+homepage: http://www.goodguide.com
+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: goodguide
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: GoodGuide Accounts API gem
+test_files: []
+