f1api 0.9.11 → 0.10.0

data/lib/f1api/activeresource/connection.rb

@@ -26,14 +26,15 @@ module FellowshipOneAPI
     def transform_response(response_body, path)
       json = JSON.parse(response_body)
       if json.keys.first == "results"
-        json = json["results"]
-        key = json.keys.find {|k| k[0] != '@'}
-        key = key.first if key.is_a? Enumerator
-        ret = []
-        json[key].each do |person|
-          ret << person
+        results = json["results"]["person"]
+        (json["results"].keys.find_all {|key| key[0] == '@' && key != '@array'}).each do |key|
+          results.each do |result|
+            result.merge!({key => json["results"][key]})
+          end
         end
-        JSON.dump({"people" => ret})
+        JSON.dump(results)
+      elsif !json[json.keys.first][json.keys.first.singularize].nil?
+        JSON.dump(json[json.keys.first][json.keys.first.singularize])
       else
         JSON.dump(json[json.keys.first])
       end

data/lib/f1api/client.rb

@@ -48,9 +48,9 @@ module FellowshipOneAPI
       end
 
       if(args[:auth_against])
-        load_consumer_config args[:auth_against]
+        load_consumer_config args[:auth_against], args[:site_url]
       else
-        load_consumer_config
+        load_consumer_config :portal, args[:site_url]
       end
 
       if(args[:oauth_token] and args[:oauth_token_secret])

data/lib/f1api/configuration.rb

@@ -3,72 +3,84 @@ module FellowshipOneAPI # :nodoc:
   #
   # This class was written to take rails environment variables like +RAILS_ENV+ and +Rails.root+ into account
   class Configuration
-    # Explictly defines where the configuration file is
-    def self.file_path=(path)
-      @config_yaml = nil
-      @file_path = path
-    end
+    class <<self
+      # Explictly defines where the configuration file is
+      def file_path=(path)
+        @config_yaml = nil
+        @file_path = path
+      end
 
-    # Reload the configuration file
-    def self.reload
-      load_yaml
-    end
+      # Reload the configuration file
+      def reload
+        load_yaml
+      end
 
-    # Gets the specified key from the configuration file
-    # [Example]    FellowshipTechAPIClient.Configuration["consumer_key"] <i># "2"</i>
-    #
-    #              FellowshipTechAPIClient.Configuration["consumer_secret"] <i># "12345678-9abc-def0-1234-567890abcdef"</i>
-    def self.[](value)
-      load_yaml if @config_yaml.nil?
-      val = @config_yaml[self.environment][value]
-      # if we have the string has "{church_code}" then we'll substitute it
-      if val =~ /\{church_code\}/ and value != "church_code"
-        return val.gsub("{church_code}", self["church_code"]) 
+      # Gets the specified key from the configuration file
+      # [Example]    FellowshipTechAPIClient.Configuration["consumer_key"] <i># "2"</i>
+      #
+      #              FellowshipTechAPIClient.Configuration["consumer_secret"] <i># "12345678-9abc-def0-1234-567890abcdef"</i>
+      def [](value)
+        load_yaml if @config_yaml.nil?
+        val = @config_yaml[self.environment][value]
+        # if we have the string has "{church_code}" then we'll substitute it
+        if val =~ /\{church_code\}/ and value != "church_code"
+          return val.gsub("{church_code}", self["church_code"]) 
+        end
+        return val
       end
-      return val
-    end
 
-    # Gets the current environment
-    def self.environment
-      @environment ||= "development" 
-      @environment ||= ::Rails.env if defined? ::Rails
-      @environment
-    end
+      # Gets the current environment
+      def environment
+        @environment ||= "development" 
+        @environment ||= ::Rails.env if defined? ::Rails
+        @environment
+      end
 
-    # Set the current environment
-    def self.environment=(env_value)
-      @environment = env_value
-    end
+      # Set the current environment
+      def environment=(env_value)
+        @environment = env_value
+      end
 
-    # Overridden method_missing to facilitate a more pleasing ruby-like syntax for accessing
-    # configuration values
-    def self.method_missing(name, *args, &block)
-      return self[name.to_s] unless self[name.to_s].nil?
-      super
-    end
+      # Overridden method_missing to facilitate a more pleasing ruby-like syntax for accessing
+      # configuration values
+      def method_missing(name, *args, &block)
+        return self[name.to_s] unless self[name.to_s].nil?
+        super
+      end
+
+      # Replace the "{church_code}" string with a custom string
+      # Meant for 1st party implementations
+      def url_with_church_code(church_code)
+        val = @config_yaml[self.environment]["url"]
+        # if we have the string has "{church_code}" then we'll substitute it
+        if val =~ /\{church_code\}/ and value != "church_code"
+          return val.gsub("{church_code}", church_code) 
+        end
+      end
 
-    private
+      private
 
-    # Loads the YAML file
-    #
-    # Starts by looking to see if file_path is defined then checks in current directory (.) and then your Rails.root and then the config 
-    # directory off of the base directory of the gem
-    def self.load_yaml
-      begin
-        if not @file_path.nil?
-          @config_yaml = YAML.load_file(@file_path)
-        elsif File.exists? "./f1-oauth.yml"
-          @config_yaml = YAML.load_file("./f1-oauth.yml")
-        elsif defined? ::Rails
-          @config_yaml = YAML.load_file("#{::Rails.root}/config/f1-oauth.yml")
-        else
-          path = File.dirname(__FILE__) + "/../../config/f1-oauth.yml"
-          @config_yaml = YAML.load_file(path)
+      # Loads the YAML file
+      #
+      # Starts by looking to see if file_path is defined then checks in current directory (.) and then your Rails.root and then the config 
+      # directory off of the base directory of the gem
+      def load_yaml
+        begin
+          if not @file_path.nil?
+            @config_yaml = YAML.load_file(@file_path)
+          elsif File.exists? "./f1-oauth.yml"
+            @config_yaml = YAML.load_file("./f1-oauth.yml")
+          elsif defined? ::Rails
+            @config_yaml = YAML.load_file("#{::Rails.root.to_s}/config/f1-oauth.yml")
+          else
+            path = File.dirname(__FILE__) + "/../../config/f1-oauth.yml"
+            @config_yaml = YAML.load_file(path)
+          end
+          true
+        rescue Exception => ex
+          puts "There was an error: #{ex.message}"
+          false
         end
-        true
-      rescue Exception => ex
-        puts "There was an error: #{ex.message}"
-        false
       end
     end
   end

data/lib/f1api/oauth.rb

@@ -19,7 +19,7 @@ module FellowshipOneAPI # :nodoc:
     alias :consumer_secret= :oauth_consumer_secret=
 
     # The OAuth access token object where all requests are made off of
-    attr_reader :oauth_access_token
+    attr_accessor :oauth_access_token
     alias :access_token :oauth_access_token
 
     # The OAuth consumer object
@@ -30,7 +30,7 @@ module FellowshipOneAPI # :nodoc:
     attr_reader :authenticated_user_uri
 
     # Creates the OAuth consumer object
-    def load_consumer_config(type = :portal)
+    def load_consumer_config(type = :portal, site_url = nil)
       case type
       when :portal
         authorize_path = FellowshipOneAPI::Configuration.portal_authorize_path
@@ -41,9 +41,10 @@ module FellowshipOneAPI # :nodoc:
       @oauth_consumer_key ||= FellowshipOneAPI::Configuration.consumer_key
       @oauth_consumer_secret ||= FellowshipOneAPI::Configuration.consumer_secret
 
-      @oauth_consumer = ::OAuth::Consumer.new(@oauth_consumer_key, 
+      url = site_url.nil? ? FellowshipOneAPI::Configuration.site_url : site_url
+      @oauth_consumer = ::OAuth::Consumer.new(@oauth_consumer_key,
                         @oauth_consumer_secret,
-                        {:site => FellowshipOneAPI::Configuration.site_url,
+                        {:site => url,
                          :request_token_path => FellowshipOneAPI::Configuration.request_token_path,
                          :access_token_path => FellowshipOneAPI::Configuration.access_token_path,
                          :authorize_path => authorize_path })

data/lib/f1api/oauth/credentials_authentication.rb

@@ -3,34 +3,39 @@ module FellowshipOneAPI # :nodoc:
   # Implements the Credentials method of authentication.  You must manage the credentials.
     module CredentialsAuthentication
       include OAuth
-      # Authorizes a user 
+      # Authenticates a user and throws and error if unable
       # +username+::   The username of the user
       # +password+::   The password of the user
       # +type+::       Can be :portal or :weblink based on which credentials you want to authenticate against
       # Returns the URI for the authenticated user
       def authenticate!(username, password, type = :portal)
-        load_consumer_config(type) if @oauth_consumer.nil?
-    
-        cred = URI.encode(Base64.encode64("#{username} #{password}"))
-    
-        case type
-        when :portal
-          auth_url = FellowshipOneAPI::Configuration.portal_credential_token_path
-        when :weblink
-          auth_url = FellowshipOneAPI::Configuration.weblink_credential_token_path
-        end
-    
-        response = @oauth_consumer.request(:post, auth_url, nil, {}, "ec=#{cred}", {'Content-Type' => 'application/x-www-form-urlencoded'})
-        
+        response = get_api_response(username, password, type)
+
         handle_response_code(response)
-        
         # Gettting the URI of the authenticated user
         @authenticated_user_uri = response["Content-Location"]
       end
       alias :authorize! :authenticate!
 
+      # Authenticates a user and returns true if successful
+      # +username+::   The username of the user
+      # +password+::   The password of the user
+      # +type+::       Can be :portal or :weblink based on which credentials you want to authenticate against
+      # Returns _true_ if was able to authenticate, _false_ if not
+      def authenticate(username, password, type = :portal)
+        response = get_api_response(username, password, type)
+
+        if(response.code.to_i == 400)
+          return false
+        end
+        handle_response_code(response)
+        @authenticated_user_uri = response["Content-Location"]
+        return true
+      end
+      alias :authorize :authenticate
+
       private
-      def handle_response_code(response)
+     def handle_response_code(response)
         case response.code.to_i
         when (200..299)
           @oauth_access_token = ::OAuth::AccessToken.from_hash(@oauth_consumer, parse_access_token(response.body))
@@ -44,7 +49,22 @@ module FellowshipOneAPI # :nodoc:
           response.error!
         end
       end
-      
+
+      def get_api_response(username, password, type)
+        load_consumer_config(type) if @oauth_consumer.nil?
+
+        cred = URI.encode(Base64.encode64("#{username} #{password}"))
+
+        case type
+        when :portal
+          auth_url = FellowshipOneAPI::Configuration.portal_credential_token_path
+        when :weblink
+          auth_url = FellowshipOneAPI::Configuration.weblink_credential_token_path
+        end
+
+        @oauth_consumer.request(:post, auth_url, nil, {}, "ec=#{cred}", {'Content-Type' => 'application/x-www-form-urlencoded'})
+      end
+
       # Parse returned OAuth access token key/secret pair
       def parse_access_token(response)
         oauth_hash = {}

data/test/fixtures/http.rb

@@ -1,13 +1,15 @@
 class HttpFixture
+  attr_accessor :code
+
+  def initialize(code = "200")
+    self.code = code
+  end
+
   def body
     "oauth_token=access&oauth_token_secret=token"
   end
-  
+
   def [](value)
     {'Content-Location' => "#{FellowshipOneAPI::Configuration.site_url}/V1/People/123456"}[value]
   end
-  
-  def code
-    "200"
-  end
-end
+end

data/test/unit/credentials_test.rb

@@ -10,18 +10,18 @@ class CredentialsTest < Test::Unit::TestCase
   def setup
     Configuration.environment = "test"
     Configuration.file_path = "#{File.dirname(__FILE__)}/../../config/f1-oauth.yml"
-    
+
     @test_username = "testuser"
     @test_password = "testpass"
-    
+
     @cred_test = CredentialsAuthenticationTest.new
     @cred_test.load_consumer_config
     @mocked_access_token = AccessTokenFixture.get(@cred_test.oauth_consumer)
     @mocked_request_token = RequestTokenFixture.get(@cred_test.oauth_consumer)
     cred = URI.encode(Base64.encode64("#{@test_username} #{@test_password}"))
-    
+
     @mocked_user_uri = "#{Configuration.site_url}/V1/People/123456"
-    
+
     @cred_test.oauth_consumer.stubs(:get_request_token).returns(@mocked_request_token)
     
     @cred_test.oauth_consumer.stubs(:request).with(:post, ::FellowshipOneAPI::Configuration.portal_credential_token_path,
@@ -57,4 +57,28 @@ class CredentialsTest < Test::Unit::TestCase
     
     assert_equal(@mocked_user_uri, @cred_test.authenticated_user_uri)
   end
+
+  def test_bool_authenticate_with_valid_creds
+    val = @cred_test.authenticate @test_username, @test_password
+
+    assert(val)
+  end
+
+  def test_bool_authenticate_with_invalid_creds
+    @cred_test.oauth_consumer.unstub(:request)
+    @cred_test.oauth_consumer.unstub(:get_request_token)
+    cred = URI.encode(Base64.encode64("#{@test_username} badpassword"))
+
+    @cred_test.oauth_consumer.expects(:request).with(:post, ::FellowshipOneAPI::Configuration.portal_credential_token_path,
+                                                      nil, {}, "ec=#{cred}", {'Content-Type' => 'application/x-www-form-urlencoded'}).returns(
+                                                      HttpFixture.new("400")).at_least_once
+    val = @cred_test.authenticate @test_username, "badpassword"
+    assert val == false
+  end
+
+  def test_site_url
+    @cred_test.load_consumer_config :portal, "http://foo.com"
+
+    assert_equal "http://foo.com", @cred_test.oauth_consumer.site
+  end
 end

data/test/unit/oauth_test.rb

@@ -72,5 +72,4 @@ class OAuthTest < Test::Unit::TestCase
     @oauth_test.authorize!
     assert_equal("#{Configuration.site_url}#{Configuration.weblink_authorize_path}", @oauth_test.oauth_consumer.authorize_url)
   end
-  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: f1api
 version: !ruby/object:Gem::Version
-  version: 0.9.11
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-05-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &2156900320 !ruby/object:Gem::Requirement
+  requirement: &2157161600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.4.4
   type: :runtime
   prerelease: false
-  version_requirements: *2156900320
+  version_requirements: *2157161600
 - !ruby/object:Gem::Dependency
   name: activeresource
-  requirement: &2156899900 !ruby/object:Gem::Requirement
+  requirement: &2157161160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,21 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156899900
-- !ruby/object:Gem::Dependency
-  name: oauth
-  requirement: &2156899280 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.4.4
-  type: :runtime
-  prerelease: false
-  version_requirements: *2156899280
+  version_requirements: *2157161160
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2156898800 !ruby/object:Gem::Requirement
+  requirement: &2157160520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156898800
+  version_requirements: *2157160520
 - !ruby/object:Gem::Dependency
   name: activeresource
-  requirement: &2156898320 !ruby/object:Gem::Requirement
+  requirement: &2157160000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156898320
+  version_requirements: *2157160000
 description: ! 'Consumes the Fellowship One API in your apps using ActiveResource.  Implements
   2nd party credentials-based authenticaion and full OAuth implementation. '
 email: jesse.dearing@activenetwork.com