fanforce 0.5.10 → 0.6.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTcxYmYwYzc5NmYzMGU4N2I4OTE2MGNmMTU1Nzc0MDZlYTdhODJkZg==
+  data.tar.gz: !binary |-
+    MzUyYWVkNzcwMGY3Nzc1Y2YxYjk5OTU5YzY4MTc4NDA0M2E1ZWQ1MQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MmQyNmI5MzZlMTBkZTUzNTk2NGZiMTA3NmZlMTA0NWFlZjQ5Y2M1NWRkZWRh
+    ZGVlOGIzZDFkYWM3Njc5NDYwZDAyYTEwMmQ1NzE2ZmJmMmZlNmI3YTk1ZDIw
+    MzhlMTQ5YzdjODZjZGEzN2ZkNDg3ZDNlNGVkZTkzYmI5MzJmMDE=
+  data.tar.gz: !binary |-
+    NTM1MzllMTg5ZmRjOGY5NmU3MWM1ZTJjZmJjZjhkN2U5NmUwNDg3YTY3Njhh
+    Y2FlZjI4NDZlN2FjZTUxNDU5YjhkMTU1OTI1NDIzYjc0NTRmNGI1MDNjOWQ0
+    Yjk5NDczOTllNWY4NDcwYzdiNWE0YTEyYjdkYTJkMzgyNmJlZTM=

data/Gemfile

@@ -1,2 +1,2 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 gemspec

data/fanforce.gemspec

@@ -1,24 +1,24 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "fanforce/version"
+require 'fanforce/api/version'
 
 Gem::Specification.new do |gem|
-  gem.name        = "fanforce"
-  gem.version     = Fanforce::VERSION
+  gem.name        = 'fanforce'
+  gem.version     = Fanforce::Api::VERSION
   gem.date        = '2012-10-19'
   gem.summary     = %q{Ruby API wrapper for Fanforce}
   gem.description = %q{Ruby API wrapper that interfaces with all six Fanforce APIs.}
-  gem.authors     = ["Caleb Clark"]
-  gem.email       = ["cclark@fanforce.com"]
-  gem.homepage    = "http://github.com/mlabs/fanforce-ruby"
+  gem.authors     = ['Caleb Clark']
+  gem.email       = ['cclark@fanforce.com']
+  gem.homepage    = 'http://github.com/mlabs/fanforce-ruby'
 
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_development_dependency 'rake'
   gem.add_runtime_dependency 'multi_json', '~> 1.3'
   gem.add_runtime_dependency 'rest-client', '~> 1.6.7'
-  gem.add_runtime_dependency 'rack', '> 1.0'
+
+  gem.add_runtime_dependency 'fanforce-internal-errors'
 end

data/lib/fanforce/{main.rb → api/_main.rb}

@@ -1,10 +1,12 @@
-require_relative 'errors'
+require 'rest-client'
 require_relative 'utils'
 require_relative 'response'
-require 'rest-client'
 
-class Fanforce
-  include Fanforce::Utils
+module Fanforce::Api
+  include Fanforce::Api::Utils
+  include Fanforce::Errors
+
+  def self.included(base) base.extend(self)  end
 
   def initialize(arg={})
     if arg.is_a?(Hash)
@@ -44,7 +46,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|
-      Fanforce::Response.new(response, request, url, req_params)
+      Fanforce::Api::Response.new(response, request, url, req_params)
     end
   end
 
@@ -52,7 +54,7 @@ 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|
-      Fanforce::Response.new(response, request, url, req_params)
+      Fanforce::Api::Response.new(response, request, url, req_params)
     end
   end
 
@@ -60,7 +62,7 @@ class Fanforce
     url = complete_url(path)
     req_params = apply_auth(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)
+      Fanforce::Api::Response.new(response, request, url, req_params)
     end
   end
 

data/lib/fanforce/api/error.rb

@@ -0,0 +1,26 @@
+require_relative 'utils'
+
+class Fanforce::Api::Error < StandardError
+  attr_accessor :path, :query_params, :request, :response, :request_url, :http_status
+
+  def initialize(response, request, path, query_params)
+    @query_params = query_params
+    @path = path
+    @request = request
+    begin
+      @response = MultiJson.load(response, :symbolize_keys => true)
+    rescue Exception => e
+      @response = "Error decoding JSON in Fanforce gem: #{e.message}"
+    end
+    @request_url = "#{@path}?#{Fanforce::Utils.to_query_string(@query_params)}"
+    super(@response.is_a?(Hash) ? @response[:msg] : @response)
+  end
+
+  def curl_command
+    method = begin @request.method rescue nil end
+    Fanforce::Utils.curl_command(method, @path, @query_params)
+  end
+
+  def code; @response.code end
+
+end

data/lib/fanforce/api/response.rb

@@ -0,0 +1,81 @@
+class Fanforce::Api::Response
+  attr_reader :curl_command, :request_url, :response_body, :response_json
+
+  def initialize(response, request, url, req_params)
+    case response.code
+    when 200, 201
+      begin
+        @response_body = response.to_s
+        @response_json = Fanforce::Utils.decode_json(response)
+        @curl_command = Fanforce::Utils.curl_command(request.method, url, req_params)
+        @request_url = url
+        if !@response_json[:results].nil?
+          @results = @response_json[:results]
+          @current_results = @response_json[:current_results]
+          @total_results = @response_json[:total_results]
+          @current_page = @response_json[:current_page]
+          @total_pages = @response_json[:total_pages]
+          if request.method == :get and @response_json[:total_pages] > @response_json[:current_page]
+            next_page = @response_json[:current_page] + 1
+            @next_url = "#{url}?#{Fanforce::Utils.to_query_string(req_params.merge(page: next_page))}"
+          end
+          if request.method == :get and @response_json[:current_page] > 1
+            prev_page = @response_json[:current_page] - 1
+            @prev_url = "#{url}?#{Fanforce::Utils.to_query_string(req_params.merge(page: prev_page))}"
+          end
+        else
+          @result = @response_json
+        end
+      rescue
+        raise
+      end
+    else
+      raise Fanforce::Api::Error.new(response, request, url, req_params)
+    end
+  end
+
+  def to_json
+    to_hash.to_json
+  end
+
+  def to_hash
+    @response_json
+  end
+
+  def [](key)
+    @response_json[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 current_results
+    @current_results || 1
+  end
+
+  def total_results
+    @total_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 → api/utils.rb}

@@ -1,19 +1,10 @@
-require 'uri'
 require 'rack/utils'
-require 'forwardable'
-require 'multi_json'
+require 'fanforce/utils'
 
-module Fanforce::Utils
-  extend Fanforce::Utils
-  def self.included(base) base.extend(self)  end
-
-  def is_blank?(obj)
-    obj.respond_to?(:empty?) ? obj.empty? : !obj
-  end
-
-  def is_present?(obj)
-    !is_blank?(obj)
-  end
+module Fanforce::Api::Utils
+  include Fanforce::Utils
+  extend Fanforce::Api::Utils
+  def self.included(base) base.extend(self) end
 
   def valid_fanforce_js_request?(params=@params)
     return false if !params.is_a?(Hash)
@@ -74,52 +65,6 @@ module Fanforce::Utils
     params.clone.delete_if { |k,v| [:api_key].include? k }
   end
 
-  def parse_url(raw_url)
-    return if is_blank?(raw_url)
-    url = URI::parse(raw_url)
-    query_params = Rack::Utils.parse_query(url.query).inject({}) do |result, (k,v)|
-      if k !~ /^ff_.+/
-        result[k] = v
-      end
-      result
-    end
-    query_string = to_query_string(Hash[query_params.sort]) if is_present?(query_params)
-    _external_id = url.host + url.path
-    clean_url = "#{url.scheme}://#{url.host}#{(if ![80,443].include?(url.port) then ":#{url.port}" end)}#{url.path}#{(if is_present?(query_string) then "?#{query_string}" end)}"
-
-    { _external_id: _external_id, clean_url: clean_url, raw_url: raw_url, query_params: query_params, query_string: query_string, scheme: url.scheme, host: url.host, port: url.port, path: url.path, fragment: url.fragment }
-  end
-
-  def to_query_string(obj, namespace=nil)
-    return '' if is_blank?(obj)
-    if obj.is_a?(Array)
-      obj.collect { |value| to_query_string(value, "#{namespace}[]") }.join '&'
-    elsif obj.is_a?(Hash)
-      obj.collect { |key, value| to_query_string(value, namespace ? "#{namespace}[#{key}]" : key) }.sort * '&'
-    elsif obj.is_a?(Object)
-      require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
-      "#{CGI.escape(to_param(namespace))}=#{CGI.escape(to_param(obj).to_s)}"
-    else
-      raise "Argument must be an object, hash, or array; instead it was a #{obj.class}"
-    end
-  end
-
-  def to_param(obj, namespace=nil)
-    if obj.is_a?(Array)
-      collect { |e| to_param(e) }.join '/'
-    elsif obj.is_a?(Hash)
-      to_query_string(obj, namespace)
-    elsif obj.is_a?(NilClass)
-      obj
-    elsif obj.is_a?(TrueClass)
-      obj
-    elsif obj.is_a?(FalseClass)
-      obj
-    elsif obj.is_a?(Object)
-      obj.to_s
-    end
-  end
-
   def log(str)
     #puts "Fanforce: #{str}"
   end
@@ -152,19 +97,5 @@ module Fanforce::Utils
     end
   end
 
-  def curl_command(method, url, req_params)
-    case method
-      when :get
-        "curl \"#{url}?#{to_query_string(req_params)}\""
-      when :post
-        "curl -X POST -d \"#{to_query_string(req_params)}\" #{url}"
-      when :put
-        "curl -X PUT -d \"#{to_query_string(req_params)}\" #{url.to_json}"
-      when :delete
-        "curl --request DELETE \"#{url}?#{to_query_string(req_params)}\""
-      else
-        raise 'Unknown request method'
-    end
-  end
 
 end

data/lib/fanforce/api/version.rb

@@ -0,0 +1,5 @@
+class Fanforce
+  module Api
+    VERSION = '0.6.0'
+  end
+end

data/lib/fanforce.rb

@@ -1,7 +1,9 @@
 class Fanforce
-  require_relative 'ff_globals'
-  require_relative 'fanforce/version'
-  require_relative 'fanforce/config'
-  require_relative 'fanforce/main'
+  require 'fanforce/errors'
+  require_relative 'fanforce/api/version'
+  require_relative 'fanforce/api/_main'
+  require_relative 'fanforce/api/ff_globals'
+  require_relative 'fanforce/api/error'
+  include Fanforce::Api
 end
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fanforce
 version: !ruby/object:Gem::Version
-  version: 0.5.10
-  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
 - Caleb Clark
@@ -11,26 +10,9 @@ bindir: bin
 cert_chain: []
 date: 2012-10-19 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,27 +34,24 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.7
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: fanforce-internal-errors
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 description: Ruby API wrapper that interfaces with all six Fanforce APIs.
 email:
 - cclark@fanforce.com
@@ -91,37 +68,35 @@ files:
 - Rakefile
 - fanforce.gemspec
 - lib/fanforce.rb
-- 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
+- lib/fanforce/api/_main.rb
+- lib/fanforce/api/error.rb
+- lib/fanforce/api/ff_globals.rb
+- lib/fanforce/api/response.rb
+- lib/fanforce/api/utils.rb
+- lib/fanforce/api/version.rb
 - test/fanforce_test.rb
 homepage: http://github.com/mlabs/fanforce-ruby
 licenses: []
+metadata: {}
 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: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby API wrapper for Fanforce
 test_files:
 - test/fanforce_test.rb

data/lib/fanforce/config.rb

@@ -1,14 +0,0 @@
-class Fanforce
-  SERVERS = {
-      dev: 'api.fanforce.gg',
-      qa: 'api.fanforce.us',
-      prod: 'api.fanforce.com'
-  }
-
-  TEST_ACCOUNT = {
-      _id: '',
-      _slug: '',
-      _password: '',
-      _api_key: ''
-  }
-end

data/lib/fanforce/errors.rb

@@ -1,55 +0,0 @@
-require_relative 'utils'
-
-class Fanforce
-  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
-      @path = path
-      @request = request
-      begin
-        @response = MultiJson.load(response, :symbolize_keys => true)
-      rescue Exception => e
-        @response = "Error decoding JSON in Fanforce gem: #{e.message}"
-      end
-      @request_url = "#{@path}?#{Fanforce::Utils.to_query_string(@query_params)}"
-      super(@response.is_a?(Hash) ? @response[:msg] : @response)
-    end
-
-    def curl_command
-      method = begin @request.method rescue nil end
-      Fanforce::Utils.curl_command(method, @path, @query_params)
-    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 UnknownError             < Error
-    def code; @http_status ||= 500; 500 end
-    def initialize(response, request, path, query_params)
-      @http_status = response.code
-      super(response, request, path, query_params)
-    end
-  end
-end

data/lib/fanforce/response.rb

@@ -1,92 +0,0 @@
-class Fanforce::Response
-  attr_reader :curl_command, :request_url, :response_body, :response_json
-
-  def initialize(response, request, url, req_params)
-    case response.code
-      when 200, 201
-        begin
-          @response_body = response.to_s
-          @response_json = Fanforce::Utils.decode_json(response)
-          @curl_command = Fanforce::Utils.curl_command(request.method, url, req_params)
-          @request_url = url
-          if !@response_json[:results].nil?
-            @results = @response_json[:results]
-            @current_results = @response_json[:current_results]
-            @total_results = @response_json[:total_results]
-            @current_page = @response_json[:current_page]
-            @total_pages = @response_json[:total_pages]
-            if request.method == :get and @response_json[:total_pages] > @response_json[:current_page]
-              next_page = @response_json[:current_page] + 1
-              @next_url = "#{url}?#{Fanforce::Utils.to_query_string(req_params.merge(page: next_page))}"
-            end
-            if request.method == :get and @response_json[:current_page] > 1
-              prev_page = @response_json[:current_page] - 1
-              @prev_url = "#{url}?#{Fanforce::Utils.to_query_string(req_params.merge(page: prev_page))}"
-            end
-          else
-            @result = @response_json
-          end
-        rescue
-          raise
-        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
-    @response_json
-  end
-
-  def [](key)
-    @response_json[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/version.rb

@@ -1,3 +0,0 @@
-class Fanforce
-  VERSION = '0.5.10'
-end