fanforce 0.5.2 → 0.5.3

data/README.md

@@ -84,12 +84,50 @@ BadRequestError
 
 ## Utils
 
-ff.curl_command(method, path, query_params)
+ff.get_url(path, query_params)
 
-ff.url(path, query_params)
+ff.curl_command(method, path, query_params)
 
 ff.validate_auth
 
+ff.to_query_string
+
+ff.compile_jquery_tmpls
+
+ff.decode_json
+
+ff.parse_url
+
+ff.remove_sensitive_params
+
+ff.remove_internal_params
+
+## Handling Results
+
+response.result
+response.results
+
+response.total_results
+response.current_results
+response.current_page
+response.total_pages
+
+## Paging
+
+response.prev_url
+response.next_url
+
+## Logging
+
+By default logging is turned off.
+```ruby
+Fanforce.config do |config|
+  config.logging = true
+end
+```
+
+For more info, see RestClient.logging.
+
 ## More Information
 
 Visit the Fanforce Developers site to explore the full API access methods available.

data/lib/fanforce/errors.rb

@@ -13,7 +13,7 @@ class Fanforce
       rescue Exception => e
         @response = "Error decoding JSON in Fanforce gem: #{e.message}"
       end
-      @request_url = "#{@path}?#{Fanforce::Utils.to_param(@query_params)}"
+      @request_url = "#{@path}?#{Fanforce::Utils.to_query_string(@query_params)}"
       super(@response.is_a?(Hash) ? @response[:msg] : @response)
     end
 

data/lib/fanforce/main.rb

@@ -1,5 +1,6 @@
 require_relative 'errors'
 require_relative 'utils'
+require_relative 'response'
 require 'rest-client'
 
 class Fanforce
@@ -23,10 +24,9 @@ class Fanforce
   end
 
   def get(path, req_params={})
-    url = complete_url(path)
     req_params = apply_auth(req_params)
-    RestClient.get(url, {:params => req_params, :accept => :json}) do |response, request, result, &block|
-      handle_response(response, request, url, req_params)
+    RestClient.get(url(path, req_params), :accept => :json) do |response, request, result, &block|
+      Fanforce::Response.new(response, request, complete_url(path), req_params)
     end
   end
 
@@ -44,7 +44,7 @@ class Fanforce
     url = complete_url(path)
     req_params = apply_auth(req_params)
     RestClient.post(url, req_params.to_json, :content_type => :json, :accept => :json) do |response, request, result, &block|
-      handle_response(response, request, url, req_params)
+      Fanforce::Response.new(response, request, url, req_params)
     end
   end
 
@@ -52,15 +52,15 @@ class Fanforce
     url = complete_url(path)
     req_params = apply_auth(req_params)
     RestClient.put(url, req_params.to_json, :content_type => :json, :accept => :json) do |response, request, result, &block|
-      handle_response(response, request, url, req_params)
+      Fanforce::Response.new(response, request, url, req_params)
     end
   end
 
   def delete(path, req_params={})
     url = complete_url(path)
     req_params = apply_auth(req_params)
-    RestClient.delete(url, {:params => req_params, :accept => :json}) do |response, request, result, &block|
-      handle_response(response, request, url, req_params)
+    RestClient.delete(url, {:params => to_query_string(req_params), :accept => :json}) do |response, request, result, &block|
+      Fanforce::Response.new(response, request, url, req_params)
     end
   end
 
@@ -74,32 +74,6 @@ class Fanforce
     {success: true}
   end
 
-  def handle_response(response, request, url, req_params)
-    log request.url
-    log request.payload.to_json
-    case response.code
-      when 200, 201
-        begin
-          response = decode_json(response)
-        rescue
-          raise UnknownError.new(response, request, url, req_params)
-        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
-        raise NotFoundError.new(response, request, url, req_params)
-      when 422
-        raise UnprocessableEntityError.new(response, request, url, req_params)
-      else
-        raise UnknownError.new(response, request, url, req_params)
-    end
-    response
-  end
-
   def auth(auth_data=nil)
     @auth_hash ||= {}
     return @auth_hash if is_blank?(auth_data)

data/lib/fanforce/response.rb

@@ -0,0 +1,88 @@
+class Fanforce::Response
+
+  def initialize(response, request, url, req_params)
+    case response.code
+      when 200, 201
+        begin
+          @raw_response = Fanforce::Utils.decode_json(response)
+          if !@raw_response[:results].nil?
+            @results = @raw_response[:results]
+            @current_results = @raw_response[:current_results]
+            @total_results = @raw_response[:total_results]
+            @current_page = @raw_response[:current_page]
+            @total_pages = @raw_response[:total_pages]
+            if request.method == :get and @raw_response[:total_pages] > @raw_response[:current_page]
+              next_page = @raw_response[:current_page] + 1
+              @next_url = "#{url}?#{Fanforce::Utils.to_query_string(req_params.merge(page: next_page))}"
+            end
+            if request.method == :get and @raw_response[:current_page] > 1
+              prev_page = @raw_response[:current_page] - 1
+              @prev_url = "#{url}?#{Fanforce::Utils.to_query_string(req_params.merge(page: prev_page))}"
+            end
+          else
+            @result = raw_json
+          end
+        rescue
+          raise Fanforce::UnknownError.new(response, request, url, req_params)
+        end
+      when 400
+        raise Fanforce::BadRequestError.new(response, request, url, req_params)
+      when 401
+        raise Fanforce::Unauthorized.new(response, request, url, req_params)
+      when 403
+        raise Fanforce::ForbiddenError.new(response, request, url, req_params)
+      when 404
+        raise Fanforce::NotFoundError.new(response, request, url, req_params)
+      when 422
+        raise Fanforce::UnprocessableEntityError.new(response, request, url, req_params)
+      else
+        raise Fanforce::UnknownError.new(response, request, url, req_params)
+    end
+    response
+  end
+
+  def to_json
+    to_hash.to_json
+  end
+
+  def to_hash
+    @raw_response
+  end
+
+  def [](key)
+    @raw_response[key]
+  end
+
+  def result
+    @result || (raise NoMethodError, 'This API response returns more than 1 record. Try using "results".')
+  end
+
+  def results
+    @results || (raise NoMethodError, 'This API response only returns 1 record. Try using "result".')
+  end
+
+  def total_results
+    @total_results || 1
+  end
+
+  def current_results
+    @current_results || 1
+  end
+
+  def current_page
+    @current_page || 1
+  end
+
+  def total_pages
+    @total_pages || 1
+  end
+
+  def prev_url
+    @prev_url || nil
+  end
+
+  def next_url
+    @next_url || nil
+  end
+
+end

data/lib/fanforce/utils.rb

@@ -106,7 +106,7 @@ module Fanforce::Utils
 
   def to_param(obj, namespace=nil)
     if obj.is_a?(Array)
-      collect { |e| e.to_param }.join '/'
+      collect { |e| to_param(e) }.join '/'
     elsif obj.is_a?(Hash)
       to_query_string(obj, namespace)
     elsif obj.is_a?(NilClass)
@@ -121,7 +121,7 @@ module Fanforce::Utils
   end
 
   def log(str)
-    puts "Fanforce: #{str}"
+    #puts "Fanforce: #{str}"
   end
 
   def decode_json(str, symbolize_keys=true)
@@ -155,13 +155,13 @@ module Fanforce::Utils
   def curl_command(method, url, req_params)
     case method
       when :get
-        "curl \"#{url}?#{to_param(req_params)}\""
+        "curl \"#{url}?#{to_query_string(req_params)}\""
       when :post
-        "curl -X POST -d \"#{to_param(req_params)}\" #{url}"
+        "curl -X POST -d \"#{to_query_string(req_params)}\" #{url}"
       when :put
-        "curl -X PUT -d \"#{to_param(req_params)}\" #{url.to_json}"
+        "curl -X PUT -d \"#{to_query_string(req_params)}\" #{url.to_json}"
       when :delete
-        "curl --request DELETE \"#{url}?#{to_param(req_params)}\""
+        "curl --request DELETE \"#{url}?#{to_query_string(req_params)}\""
       else
         raise 'Unknown request method'
     end

data/lib/fanforce/version.rb

@@ -1,3 +1,3 @@
 class Fanforce
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fanforce
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -94,6 +94,7 @@ files:
 - lib/fanforce/config.rb
 - lib/fanforce/errors.rb
 - lib/fanforce/main.rb
+- lib/fanforce/response.rb
 - lib/fanforce/utils.rb
 - lib/fanforce/version.rb
 - lib/ff_globals.rb