fanforce 0.4.6 → 0.4.7

data/README.md

@@ -28,14 +28,14 @@ require 'fanforce'
 api_key = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
 
 # set up a client to talk to the Fanforce API
-@ff = Fanforce.new api_key
+ff = Fanforce.new api_key
 ```
 
 ### Making Your First Call
 
 ``` ruby
 # get your api access info
-@ff.get('/access_info', {})
+ff.get('/access_info', {})
 ```
 
 ## Full REST Access
@@ -66,11 +66,13 @@ ff.delete('/')
 
 ## Error Handling
 
+```ruby
 begin
-
+    ff.get('/bad_page')
 rescue Fanforce::Error => e
-
+    puts e.curl_command
 end
+```
 
 e.curl_command
 e.response_code
@@ -78,6 +80,16 @@ e.response_body
 e.request_url
 e.request_params
 
+BadRequestError
+
+## Utils
+
+ff.curl_command(method, path, query_params)
+
+ff.url(path, query_params)
+
+ff.validate_auth
+
 ## More Information
 
 Visit the Fanforce Developers site to explore the full API access methods available.

data/lib/fanforce/errors.rb

@@ -1,9 +1,8 @@
 require_relative 'utils'
 
 class Fanforce
-  class Error < StandardError;
-    include ::Fanforce::Utils
-    attr_accessor :path, :query_params, :request, :response, :request_url
+  class Error < StandardError
+    attr_accessor :path, :query_params, :request, :response, :request_url, :http_status
 
     def initialize(response, request, path, query_params)
       @query_params = query_params
@@ -12,38 +11,45 @@ class Fanforce
       begin
         @response = MultiJson.load(response, :symbolize_keys => true)
       rescue Exception => e
-        @response = "JSON decode error in Gem: #{e.message}"
+        @response = "Error decoding JSON in Fanforce gem: #{e.message}"
       end
-      @request_url = "#{@path}?#{to_param(@query_params)}"
+      @request_url = "#{@path}?#{Fanforce::Utils.to_param(@query_params)}"
       super(@response.is_a?(Hash) ? @response[:msg] : @response)
     end
 
     def curl_command
       method = begin @request.method rescue nil end
-      case method
-        when :get
-          "curl \"#{@path}?#{to_param(@query_params)}\""
-        when :post
-          "curl -X POST -d \"#{to_param(@query_params)}\" #{@path}"
-        when :put
-          "curl -X PUT -d \"#{to_param(@query_params)}\" #{@path.to_json}"
-        when :delete
-          "curl --request DELETE \"#{@path}?#{to_param(@query_params)}\""
-        else
-          "Unknown request method so used POST: curl -X POST -d \"#{to_param(@query_params)}\" #{@path}"
-      end
+      Fanforce::Utils.curl_command(method, @path, @query_params)
     end
-    def code() end
+
+    def code; end
+  end
+
+  class BadRequestError          < Error
+    def code; @http_status = 400     end
+  end
+
+  class Unauthorized             < Error
+    def code; @http_status = 401     end
+  end
+
+  class ForbiddenError           < Error
+    def code; @http_status = 403     end
+  end
+
+  class NotFoundError            < Error
+    def code; @http_status = 404     end
+  end
+
+  class UnprocessableEntityError < Error
+    def code; @http_status = 422     end
   end
 
-  class BadRequestError < Error;          def code() 400 end end
-  class ForbiddenError < Error;           def code() 403 end end
-  class NotFoundError < Error;            def code() 404 end end
-  class UnprocessableEntityError < Error; def code() 422 end end
-  class UnknownError < Error;
-    def code() @code ||= 500 end
+  class UnknownError             < Error
+    def code; @http_status ||= 500; 500 end
     def initialize(response, request, path, query_params)
-      @code = response.code
+      @http_status = response.code
+      super(response, request, path, query_params)
     end
   end
 end

data/lib/fanforce/main.rb

@@ -5,6 +5,7 @@ require 'rest-client'
 class Fanforce
   include Fanforce::Utils
   ########################################################################
+
   def initialize(arg={})
     if arg.is_a?(Hash)
       add_params(arg)
@@ -30,27 +31,14 @@ class Fanforce
     end
   end
 
-  def get_url(path, req_params={})
-    url = complete_url(path)
+  def url(path, req_params={})
     req_params = apply_auth(req_params)
-    "#{url}?#{to_query_string(req_params)}"
+    "#{complete_url(path)}?#{to_query_string(req_params)}"
   end
 
-  def get_curl_command(method, path, req_params={})
+  def curl_command(method, path, req_params={})
     req_params = apply_auth(req_params)
-    url = complete_url(path)
-    case method
-      when :get
-        "curl \"#{url}?#{to_param(req_params)}\""
-      when :post
-        "curl -X POST -d \"#{to_param(req_params)}\" #{url}"
-      when :put
-        "curl -X PUT -d \"#{to_param(req_params)}\" #{url.to_json}"
-      when :delete
-        "curl --request DELETE \"#{url}?#{to_param(req_params)}\""
-      else
-        raise 'Unknown request method'
-    end
+    Fanforce::Utils.curl_command(method, complete_url(path), req_params)
   end
 
   def post(path, req_params={})
@@ -97,6 +85,8 @@ class Fanforce
         end
       when 400
         raise BadRequestError.new(response, request, url, req_params)
+      when 401
+        raise Unauthorized.new(response, request, url, req_params)
       when 403
         raise ForbiddenError.new(response, request, url, req_params)
       when 404

data/lib/fanforce/utils.rb

@@ -1,8 +1,9 @@
 require 'uri'
 require 'rack/utils'
+require 'forwardable'
 
 module Fanforce::Utils
-  def self.included(base) base.extend(self)  end
+  extend Fanforce::Utils
 
   def is_blank?(obj)
     obj.respond_to?(:empty?) ? obj.empty? : !obj
@@ -144,4 +145,19 @@ module Fanforce::Utils
     end
   end
 
+  def curl_command(method, url, req_params)
+    case method
+      when :get
+        "curl \"#{url}?#{to_param(req_params)}\""
+      when :post
+        "curl -X POST -d \"#{to_param(req_params)}\" #{url}"
+      when :put
+        "curl -X PUT -d \"#{to_param(req_params)}\" #{url.to_json}"
+      when :delete
+        "curl --request DELETE \"#{url}?#{to_param(req_params)}\""
+      else
+        raise 'Unknown request method'
+    end
+  end
+
 end

data/lib/fanforce/version.rb

@@ -1,3 +1,3 @@
 class Fanforce
-  VERSION = '0.4.6'
+  VERSION = '0.4.7'
 end

data/lib/fanforce.rb

@@ -1,6 +1,7 @@
 class Fanforce
+  require_relative 'ff_globals'
+  require_relative 'fanforce/version'
+  require_relative 'fanforce/config'
+  require_relative 'fanforce/main'
 end
-require_relative 'ff_globals'
-require_relative 'fanforce/version'
-require_relative 'fanforce/config'
-require_relative 'fanforce/main'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fanforce
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
   prerelease: 
 platform: ruby
 authors: