sfdc 3.0.0 → 3.0.1

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/sfdc.rb

@@ -69,5 +69,6 @@ module Sfdc
       self
     end
   end
+  
   Object.send :include, Sfdc::CoreExtensions unless Object.respond_to? :tap
 end

data/lib/sfdc/abstract_client.rb

@@ -6,4 +6,4 @@ module Sfdc
     include Sfdc::Concerns::Caching
     include Sfdc::Concerns::API
   end
-end
+end

data/lib/sfdc/attachment.rb

@@ -1,6 +1,5 @@
 module Sfdc
   class Attachment < Sfdc::SObject
-
     # Public: Returns the body of the attachment.
     #
     # Examples
@@ -18,6 +17,5 @@ module Sfdc
       return true if self.Body?
       raise 'You need to query the Body for the record first.'
     end
-
   end
 end

data/lib/sfdc/concerns/api.rb

@@ -300,7 +300,7 @@ module Sfdc
         api_get(field ? "sobjects/#{sobject}/#{field}/#{id}" : "sobjects/#{sobject}/#{id}").body
       end
 
-    private
+      private
 
       # Internal: Returns a path to an api endpoint
       #
@@ -316,7 +316,6 @@ module Sfdc
       def exceptions
         [Faraday::Error::ClientError]
       end
-
     end
   end
 end

data/lib/sfdc/concerns/authentication.rb

@@ -2,7 +2,7 @@ module Sfdc
   module Concerns
     module Authentication
 
-      # Public: Force an authentication
+      # Public: Sfdc an authentication
       def authenticate!
         raise AuthenticationError, 'No authentication middleware present' unless authentication_middleware
         middleware = authentication_middleware.new nil, self, options
@@ -34,7 +34,6 @@ module Sfdc
           options[:client_id] &&
           options[:client_secret]
       end
-
     end
   end
 end

data/lib/sfdc/concerns/base.rb

@@ -1,12 +1,11 @@
 module Sfdc
   module Concerns
     module Base
-
       attr_reader :options
 
       # Public: Creates a new client instance
       #
-      # opts - A hash of options to be passed in (default: {}).
+      # options - A hash of options to be passed in (default: {}).
       #        :username               - The String username to use (required for password authentication).
       #        :password               - The String password to use (required for password authentication).
       #        :security_token         - The String security token to use (required for password authentication).
@@ -40,10 +39,10 @@ module Sfdc
       #
       #        :authentication_callback
       #                                - A Proc that is called with the response body after a successful authentication.
-      def initialize(opts = {})
-        raise ArgumentError, 'Please specify a hash of options' unless opts.is_a?(Hash)
+      def initialize(options = {})        
         @options = Hash[Sfdc.configuration.options.map { |option| [option, Sfdc.configuration.send(option)] }]
-        @options.merge! opts
+        @options.merge!(options)
+
         yield builder if block_given?
       end
 
@@ -55,7 +54,6 @@ module Sfdc
       def inspect
         "#<#{self.class} @options=#{@options.inspect}>"
       end
-
     end
   end
-end
+end

data/lib/sfdc/concerns/caching.rb

@@ -1,7 +1,6 @@
 module Sfdc
   module Concerns
     module Caching
-
       # Public: Runs the block with caching disabled.
       #
       # block - A query/describe/etc.
@@ -14,13 +13,12 @@ module Sfdc
         options.delete(:use_cache)
       end
 
-    private
+      private
 
       # Internal: Cache to use for the caching middleware
       def cache
         options[:cache]
       end
-
     end
   end
 end

data/lib/sfdc/concerns/canvas.rb

@@ -1,12 +1,10 @@
 module Sfdc
   module Concerns
     module Canvas
-
       def decode_signed_request(signed_request)
         raise 'client_secret not set.' unless options[:client_secret]
         SignedRequest.decode(signed_request, options[:client_secret])
       end
-
     end
   end
 end

data/lib/sfdc/concerns/connection.rb

@@ -1,7 +1,6 @@
 module Sfdc
   module Concerns
     module Connection
-
       # Public: The Faraday::Builder instance used for the middleware stack. This
       # can be used to insert an custom middleware.
       #
@@ -14,9 +13,10 @@ module Sfdc
       def middleware
         connection.builder
       end
+
       alias_method :builder, :middleware
 
-    private
+      private
 
       # Internal: Internal faraday connection where all requests go through
       def connection
@@ -68,7 +68,6 @@ module Sfdc
       def mashify?
         middleware.handlers.index(Sfdc::Middleware::Mashify)
       end
-
     end
   end
 end

data/lib/sfdc/concerns/picklists.rb

@@ -1,7 +1,6 @@
 module Sfdc
   module Concerns
     module Picklists
-
       # Public: Get the available picklist values for a picklist or multipicklist field.
       #
       # sobject - The String name of the sobject.
@@ -27,7 +26,7 @@ module Sfdc
         PicklistValues.new(describe(sobject)['fields'], field, options)
       end
 
-    private
+      private
 
       class PicklistValues < Array
 
@@ -82,9 +81,7 @@ module Sfdc
           valid_for = picklist_entry['validFor'].ljust(16, 'A').unpack('m').first.unpack('q*')
           (valid_for[index >> 3] & (0x80 >> index % 8)) != 0
         end
-
       end
-
     end
   end
 end

data/lib/sfdc/concerns/streaming.rb

@@ -1,7 +1,6 @@
 module Sfdc
   module Concerns
     module Streaming
-
       # Public: Subscribe to a PushTopic
       #
       # channels - The name of the PushTopic channel(s) to subscribe to.
@@ -15,17 +14,18 @@ module Sfdc
       # Public: Faye client to use for subscribing to PushTopics
       def faye
         raise 'Instance URL missing. Call .authenticate! first.' unless options[:instance_url]
+        
         @faye ||= Faye::Client.new("#{options[:instance_url]}/cometd/#{options[:api_version]}").tap do |client|
           client.bind 'transport:down' do
             Sfdc.log "[COMETD DOWN]"
             client.set_header 'Authorization', "OAuth #{authenticate!.access_token}"
           end
+
           client.bind 'transport:up' do
             Sfdc.log "[COMETD UP]"
           end
         end
       end
-
     end
   end
 end

data/lib/sfdc/concerns/verbs.rb

@@ -1,7 +1,6 @@
 module Sfdc
   module Concerns
     module Verbs
-
       # Internal: Define methods to handle a verb.
       #
       # verbs - A list of verbs to define methods for.
@@ -62,7 +61,6 @@ module Sfdc
           send(verb, *args, &block)
         end
       end
-
     end
   end
 end

data/lib/sfdc/config.rb

@@ -56,6 +56,7 @@ module Sfdc
       end
 
     private
+    
       attr_reader :default
       alias_method :default_provided?, :default
 

data/lib/sfdc/middleware/authentication.rb

@@ -62,10 +62,12 @@ module Sfdc
       end
     end
 
-  private
+    private
+
     def faraday_options
       { :url   => "https://#{@options[:host]}",
-        :proxy => @options[:proxy_uri] }.reject { |k, v| v.nil? }
+        :proxy => @options[:proxy_uri] 
+      }.reject { |k, v| v.nil? }
     end
   end
 end

data/lib/sfdc/middleware/authentication/password.rb

@@ -1,20 +1,17 @@
 module Sfdc
-
   # Authentication middleware used if username and password flow is used
   class Middleware::Authentication::Password < Sfdc::Middleware::Authentication
-
     def params
       { :grant_type    => 'password',
         :client_id     => @options[:client_id],
         :client_secret => @options[:client_secret],
         :username      => @options[:username],
-        :password      => password }
+        :password      => password 
+      }
     end
 
     def password
       "#{@options[:password]}#{@options[:security_token]}"
     end
-  
   end
-
 end

data/lib/sfdc/middleware/authorization.rb

@@ -1,7 +1,5 @@
 module Sfdc
-
-  # Piece of middleware that simply injects the OAuth token into the request
-  # headers.
+  # Middleware that simply injects the OAuth token into the request headers.
   class Middleware::Authorization < Sfdc::Middleware
     AUTH_HEADER = 'Authorization'.freeze
 
@@ -13,7 +11,5 @@ module Sfdc
     def token
       @options[:oauth_token]
     end
-  
   end
-
 end

data/lib/sfdc/middleware/caching.rb

@@ -1,6 +1,5 @@
 module Sfdc
   class Middleware::Caching < FaradayMiddleware::Caching
-
     def call(env)
       expire(cache_key(env)) unless use_cache?
       super
@@ -19,6 +18,5 @@ module Sfdc
     def use_cache?
       !@options.has_key?(:use_cache) || @options[:use_cache]
     end
-
   end
 end

data/lib/sfdc/middleware/instance_url.rb

@@ -1,8 +1,6 @@
 module Sfdc
-
   # Middleware which asserts that the instance_url is always set
   class Middleware::InstanceURL < Sfdc::Middleware
-
     def call(env)
       # If the connection url_prefix isn't set, we must not be authenticated.
       raise Sfdc::UnauthorizedError, 'Connection prefix not set' unless url_prefix_set?
@@ -12,7 +10,5 @@ module Sfdc
     def url_prefix_set?
       !!(connection.url_prefix && connection.url_prefix.host)
     end
-  
   end
-
 end

data/lib/sfdc/middleware/mashify.rb

@@ -2,7 +2,6 @@ module Sfdc
   # Middleware the converts sobject records from JSON into Sfdc::SObject objects
   # and collections of records into Sfdc::Collection objects.
   class Middleware::Mashify < Sfdc::Middleware
-
     def call(env)
       @env = env
       response = @app.call(env)
@@ -12,7 +11,6 @@ module Sfdc
 
     def body
       @env[:body]
-    end
-  
+    end  
   end
 end

data/lib/sfdc/middleware/multipart.rb

@@ -10,7 +10,8 @@ module Sfdc
         env[:request_headers][CONTENT_TYPE] += ";boundary=#{env[:request][:boundary]}"
         env[:body] = create_multipart(env, params)
       end
-      @app.call env
+
+      @app.call(env)
     end
 
     def process_request?(env)
@@ -28,17 +29,17 @@ module Sfdc
           return true if (val.respond_to?(:content_type) || has_multipart?(val))
         end
       end
-      false
+      
+      return false
     end
 
     def create_multipart(env, params)
       boundary = env[:request][:boundary]
+      
       parts = []
 
-      # Fields
       parts << Faraday::Parts::Part.new(boundary, 'entity_content', params.reject { |k,v| v.respond_to? :content_type }.to_json)
 
-      # Files
       params.each do |k,v|
         parts << Faraday::Parts::Part.new(boundary, k.to_s, v) if v.respond_to? :content_type
       end
@@ -47,6 +48,7 @@ module Sfdc
 
       body = Faraday::CompositeReadIO.new(parts)
       env[:request_headers]['Content-Length'] = body.length.to_s
+      
       return body
     end
   end

data/lib/sfdc/signed_request.rb

@@ -29,6 +29,7 @@ module Sfdc
     end
     
   private
+
     attr_reader :client_secret, :signature, :payload
 
     def split_components(signed_request)
@@ -43,6 +44,5 @@ module Sfdc
     def digest
       OpenSSL::Digest::Digest.new('sha256')
     end
-
   end
 end

data/lib/sfdc/tooling/client.rb

@@ -1,13 +1,11 @@
 module Sfdc
   module Tooling
     class Client < AbstractClient
-
       private
 
-        def api_path(path)
-          super("tooling/#{path}")
-        end
-
+      def api_path(path)
+        super("tooling/#{path}")
+      end
     end
   end
-end
+end

data/lib/sfdc/version.rb

@@ -1,3 +1,3 @@
 module Sfdc
-  VERSION = '3.0.0'
-end
+  VERSION = '3.0.1'
+end

data/sfdc.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sfdc/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = "sfdc"
+  s.version       = Sfdc::VERSION
+  s.authors       = ["Bruce Yue"]
+  s.email         = ["bruce.yue@outlook.com"]
+  s.description   = "A lightweight ruby client for the Salesforce REST api."
+  s.summary       = "A lightweight ruby client for the Salesforce REST api."
+  s.homepage      = "http://www.sharealltech.com"
+
+  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|example|log|pkg|script|spec|test|vendor)/ }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'faraday', '~> 0.8.4'
+  s.add_dependency 'faraday_middleware', '>= 0.8.8'
+  s.add_dependency 'json', ['>= 1.7.5', '< 1.9.0']
+  s.add_dependency 'hashie', ['>= 1.2.0', '< 2.1']
+
+  s.add_development_dependency 'rspec', '~> 2.14.0'
+  s.add_development_dependency 'webmock', '~> 1.13.0'
+  s.add_development_dependency 'simplecov', '~> 0.7.1'
+  s.add_development_dependency 'faye' unless RUBY_PLATFORM == 'java'
+end