salesforceapi-rest 0.0.1

data/lib/salesforceapi-rest/errors.rb

@@ -0,0 +1,95 @@
+module SalesforceApi
+  module Errors
+
+    class ApiError < RuntimeError
+
+      attr_accessor :http_code
+
+      def initialize(message, http_code)
+        super message
+        @http_code = http_code
+      end
+    end
+
+    class RuntimeError < ApiError
+      def initialize(message, http_code)
+        super(message, http_code)
+      end
+    end
+
+    # Error for HTTP code 401, Session ID or Auth token expired
+    class AuthenticationError < ApiError
+      def initialize(message, http_code)
+        super(message, http_code)
+      end
+    end
+
+    # Error for HTTP code 400, Request cannot be understood, because the JSON
+    # or XML body has an error
+    class RequestError < ApiError
+      def initialize(message, http_code)
+        super(message, http_code)
+      end
+    end
+
+    # Error for HTTP code 403, Request cannot be understood, because the JSON
+    # or XML body has an error
+    class RequestRefusedError < ApiError
+      def initialize(message, http_code)
+        super(message, http_code)
+      end
+    end
+
+    # Error for HTTP code 404, Requested resource cannot be found. Check URI for error.
+    class ResourceNotFoundError < ApiError
+      def initialize(message, http_code)
+        super(message, http_code)
+      end
+    end
+
+    # Error for HTTP code 405, The method specified in the Request-Line is not allowed.
+    class MethodError < ApiError
+      def initialize(message, http_code)
+        super(message, http_code)
+      end
+    end
+
+    # Error for HTTP code 415. The entity specified in the request is in a format
+    # that is supported by the specified resource for the specified method.
+    class EntityError < ApiError
+      def initialize(message, http_code)
+        super(message, http_code)
+      end
+    end
+
+    # Error for HTTP code 500, Force.com Internal Server error
+    class Platformrror < ApiError
+      def initialize(message, http_code)
+        super(message, http_code)
+      end
+    end
+
+    class ErrorManager
+      def self.raise_error(message, http_code)
+        case http_code
+        when 400
+          raise SalesforceApi::Errors::RequestError.new(message, http_code)
+        when 401
+          raise SalesforceApi::Errors::AuthenticationError.new(message, http_code)
+        when 403
+          raise SalesforceApi::Errors::RequestError.new(message, http_code)
+        when 404
+          raise SalesforceApi::Errors::ResourceNotFoundError.new(message, http_code)
+        when 405
+          raise SalesforceApi::Errors::MethodError.new(message, http_code)
+        when 415
+          raise SalesforceApi::Errors::EntityError.new(message, http_code)
+        when 500
+          raise SalesforceApi::Errors::PlatformError.new(message, http_code)
+        else
+          raise SalesforceApi::Errors::RuntimeError.new(message, http_code)
+        end
+      end
+    end
+  end
+end

data/lib/salesforceapi-rest/request.rb

@@ -0,0 +1,16 @@
+require 'httparty'
+
+module SalesforceApi
+  module Request
+    def self.do_request (verb, target, headers, data=nil)
+      case verb
+      when 'GET'
+        return resp = HTTParty.get(target, :headers => headers)
+      when 'POST'
+        return resp = HTTParty.post(target, :body => data, :headers => headers)
+      when 'DELETE'
+        return resp = HTTParty.delete(target, :headers => headers)
+      end
+    end
+  end
+end

data/lib/salesforceapi-rest/sobject.rb

@@ -0,0 +1,12 @@
+module SalesforceApi
+  module Rest
+
+    class Sobject
+
+      def initialize(attributes, type)
+        @attributes = attributes
+        @type = type
+      end
+    end
+  end
+end

data/lib/salesforceapi-rest/version.rb

@@ -0,0 +1,5 @@
+module Salesforceapi
+  module Rest
+    VERSION = "0.0.1"
+  end
+end

data/lib/salesforceapi-rest.rb

@@ -0,0 +1,91 @@
+require "salesforceapi-rest/version"
+require "salesforceapi-rest/sobject"
+require "salesforceapi-rest/request"
+require "salesforceapi-rest/errors"
+require 'net/https'
+require 'net/http'
+require 'active_resource'
+require 'httparty'
+
+module Salesforceapi
+  module Rest
+    class Client
+      include HTTParty
+      extend SalesforceApi::Request
+
+      base_uri "https://na7.salesforce.com"
+      default_params :output => 'json'
+      format :json
+      @@ssl_port = 443
+
+      # set header for httparty
+      def self.set_headers (auth_setting)
+        headers (auth_setting)
+      end
+
+      def initialize(oauth_token, instance_uri, api_version = "v21.0")
+        @oauth_token = oauth_token
+        @instance_uri = instance_uri
+        @api_version = api_version ? api_version : "v21.0"  #take a dynamic api server version
+        @full_url = instance_uri + "/services/data/#{api_version}/sobjects"
+        @ssl_port = 443  # TODO, right SF use port 443 for all HTTPS traffic.
+
+
+        # To be used by HTTParty
+        @auth_header = {
+          "Authorization" => "OAuth " + @oauth_token,
+          "content-Type" => 'application/json'
+        }
+        # either application/xml or application/json
+        self.class.base_uri @instance_uri
+
+      end
+
+
+      def save(object, attributes)
+
+        path = "/services/data/#{@api_version}/sobjects/#{object}/"
+        target = @instance_uri + path
+
+        data = ActiveSupport::JSON::encode(attributes)
+
+        resp = SalesforceApi::Request.do_request("POST", target, @auth_header, data)
+
+        # HTTP code 201 means it was successfully saved.
+        if resp.code != 201
+          message = ActiveSupport::JSON.decode(resp.body)[0]["message"]
+          SalesforceApi::Errors::ErrorManager.raise_error("HTTP code " + resp.code.to_s + ": " + message, resp.code)
+        else
+          return ActiveSupport::JSON.decode(resp.body)
+        end
+
+      end
+
+      def describe(object)
+        path = "/services/data/#{@api_version}/sobjects/#{object}/describe"
+        target = @instance_uri + path
+
+        resp = SalesforceApi::Request.do_request("GET", target, @auth_header, nil)
+        if (resp.code != 200) || !resp.success?
+          message = ActiveSupport::JSON.decode(resp.body)[0]["message"]
+          SalesforceApi::Errors::ErrorManager.raise_error("HTTP code " + resp.code.to_s + ": " + message, resp.code)
+        else
+          return ActiveSupport::JSON.decode(resp.body)
+        end
+      end
+
+      def resources
+        path = "/services/data/#{@api_version}"
+        target = @instance_uri + path
+
+        resp = SalesforceApi::Request.do_request("GET", target, @auth_header, nil)
+        if (resp.code != 200) || !resp.success?
+          message = ActiveSupport::JSON.decode(resp.body)[0]["message"]
+          SalesforceApi::Errors::ErrorManager.raise_error("HTTP code " + resp.code.to_s + ": " + message, resp.code)
+        else
+          return ActiveSupport::JSON.decode(resp.body)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: salesforceapi-rest
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Lucas Allan Amorim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rforce
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: omniauth
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: active_resource
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Ruby wrapper to access salesforce rest api
+email: 
+- lucas.allan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/salesforceapi-rest/errors.rb
+- lib/salesforceapi-rest/request.rb
+- lib/salesforceapi-rest/sobject.rb
+- lib/salesforceapi-rest/version.rb
+- lib/salesforceapi-rest.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper to access salesforce rest api
+test_files: []
+