edh 0.2 → 0.3

data/changelog.md

@@ -1,3 +1,9 @@
+v0.3
+====
+
+* Allow config to be set via a block.
+
+
 v0.2
 ====
 

data/lib/edh/api.rb

@@ -3,18 +3,39 @@ require 'edh/api/rest_api'
 
 module EDH
   module Passport
+    class << self
+      attr_accessor :configuration
+      
+      def config
+        self.configuration || Configuration.new
+      end
+    end
+    
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    class Configuration
+      attr_accessor :access_token, :app_access_token, :server
+
+      def initialize
+      end
+    end
+
     class API
+      attr_accessor :access_token, :app_access_token, :server
+      
       # Creates a new API client.
       # @param [String] access_token access token
       # @note If no access token is provided, you can only access some public information.
       # @return [EDH::Passport::API] the API client
       def initialize options = {}
-        @access_token = options[:access_token]
-        @app_access_token = options[:app_token]
-        @server = options[:server]
+         @access_token = options[:access_token] || Passport.config.access_token
+         @app_access_token = options[:app_access_token] || Passport.config.app_access_token
+         @server = options[:server] || Passport.config.server
       end
 
-      attr_accessor :access_token
 
       include RestAPIMethods
 

data/lib/edh/version.rb

@@ -1,3 +1,3 @@
 module EDH
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/readme.md

@@ -1,36 +1,53 @@
+[![Build Status](https://travis-ci.org/everydayhero/edh.png?branch=master)](https://travis-ci.org/everydayhero/edh)
+
 ####config/initializers
-#### defaults to using production
+
+####optional 
 ```ruby
-$passport_client = EDH::Passport::API.new
+#Configure passport connection
+EDH::Passport.configure do |config|
+  config.server = 'http://dummy-passport.dev'
+  config.app_access_token = "123456"
+end
 ```
 
-####optional 
+##Setup a client without a user access token
 ```ruby
-#options: app_token, server, access_token (user)
-#access_token is used for sending requests first, then falls back to app_token if that exists.
-$passport_client = EDH::Passport::API.new(:server => "http://dummy-passport.dev")
+passport_client = EDH::Passport::API.new
 ```
-####set the user token
+
+##Setup a client with a user access token
 ```ruby
-$passport_client.access_token = "abc"
+passport_client = EDH::Passport::API.new(:access_token => "user_token")
 ```
 
 ####create returns an action id
 ```ruby
-$passport_client.create("pages.fundraise", {:abc => "def", :cats => "dogs"})
+passport_client.create("pages.fundraise", {:abc => "def", :cats => "dogs"})
 => 1234
 #sending json example
-$passport_client.create("pages.fundraise", "{\"abc\":\"def\",\"cats\":\"dogs\"}")
+passport_client.create("pages.fundraise", "{\"abc\":\"def\",\"cats\":\"dogs\"}")
 ```
 
 ####update an action
 ```ruby
-$passport_client.update(1234, {:abc => "12345", :cats => "6789"})
+passport_client.update(1234, {:abc => "12345", :cats => "6789"})
 ```
 
 ####delete an action
 ```ruby
-$passport_client.delete(1234)
+passport_client.delete(1234)
+```
+
+Errors
+-----
+
+Errors that can be raised are:
+```ruby
+EDH::Passport::ServerError #5XX error on Passport
+EDH::Passport::ClientError #4XX error on Passport
+MultiJson::DecodeError #Response decode error
+Faraday::Error::ConnectionFailed #connection failure
 ```
 
 

data/spec/cases/api_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 describe "EDH::Passport::API" do
   before(:each) do
+    EDH::Passport.configuration = nil
     @service = EDH::Passport::API.new
   end
 
@@ -35,6 +36,24 @@ describe "EDH::Passport::API" do
     service = EDH::Passport::API.new(:access_token => token)
     service.access_token.should == token
   end
+  
+  it "has an attr_reader for app token" do
+    EDH::Passport.configure do |config|
+      config.app_access_token = "my app token"
+    end
+
+    service = EDH::Passport::API.new
+    service.app_access_token.should == "my app token"
+  end
+  
+  it "has an attr_reader for server" do
+    EDH::Passport.configure do |config|
+      config.server = "http://example.com"
+    end
+
+    service = EDH::Passport::API.new
+    service.server.should == "http://example.com"
+  end
 
   it "gets the attribute of a EDH::HTTPService::Response given by the http_component parameter" do
     http_component = :method_name

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edh
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors: