force 0.0.1

data/lib/force/signed_request.rb

@@ -0,0 +1,48 @@
+require 'openssl'
+require 'base64'
+require 'json'
+
+module Force
+  class SignedRequest
+    # Public: Initializes and decodes the signed request
+    #
+    # signed_request - The POST message containing the signed request from Salesforce.
+    # client_secret  - The oauth client secret used to encrypt the signed request.
+    #
+    # Returns the parsed JSON context.
+    def self.decode(signed_request, client_secret)
+      new(signed_request, client_secret).decode
+    end
+
+    def initialize(signed_request, client_secret)
+      @client_secret = client_secret
+      split_components(signed_request)
+    end
+
+    # Public: Decode the signed request.
+    #
+    # Returns the parsed JSON context.
+    # Returns nil if the signed request is invalid.
+    def decode
+      return nil if signature != hmac
+      JSON.parse(Base64.decode64(payload))
+    end
+    
+    private
+
+    attr_reader :client_secret, :signature, :payload
+
+    def split_components(signed_request)
+      @signature, @payload = signed_request.split('.')
+      @signature = Base64.decode64(@signature)
+    end
+
+    def hmac
+      OpenSSL::HMAC.digest(digest, client_secret, payload)
+    end
+
+    def digest
+      OpenSSL::Digest::Digest.new('sha256')
+    end
+  end
+end

data/lib/force/sobject.rb

@@ -0,0 +1,68 @@
+module Force
+  class SObject < Force::Mash
+
+    def sobject_type
+      self.attributes['type']
+    end
+
+    # Public: Get the describe for this sobject type
+    def describe
+      @client.describe(sobject_type)
+    end
+
+    # Public: Describe layouts for this sobject type
+    def describe_layouts(layout_id = nil)
+      @client.describe_layouts(sobject_type, layout_id)
+    end
+
+    # Public: Persist the attributes to Salesforce.
+    #
+    # Examples
+    #
+    #   account = client.query('select Id, Name from Account').first
+    #   account.Name = 'Foobar'
+    #   account.save
+    def save
+      ensure_id
+      @client.update(sobject_type, attrs)
+    end
+
+    def save!
+      ensure_id
+      @client.update!(sobject_type, attrs)
+    end
+
+    # Public: Destroy this record.
+    #
+    # Examples
+    #
+    #   account = client.query('select Id, Name from Account').first
+    #   account.destroy
+    def destroy
+      ensure_id
+      @client.destroy(sobject_type, self.Id)
+    end
+
+    def destroy!
+      ensure_id
+      @client.destroy!(sobject_type, self.Id)
+    end
+
+    # Public: Returns a hash representation of this object with the attributes
+    # key and parent/child relationships removed.
+    def attrs
+      self.to_hash.reject { |key, _| key =~ /.*__r/ || key =~ /^attributes$/ }
+    end
+
+    def to_sparam
+      self.Id
+    end
+
+  private
+
+    def ensure_id
+      return true if self.Id?
+      raise ArgumentError, 'You need to query the Id for the record first.'
+    end
+  end
+end

data/lib/force/tooling/client.rb

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

data/lib/force/upload_io.rb

@@ -0,0 +1,20 @@
+require 'faraday/upload_io'
+
+module Force
+  UploadIO = Faraday::UploadIO
+end
+
+module Faraday
+  module Parts
+    class ParamPart
+      def build_part(boundary, name, value)
+        part = ''
+        part << "--#{boundary}\r\n"
+        part << "Content-Disposition: form-data; name=\"#{name.to_s}\";\r\n"
+        part << "Content-Type: application/json\r\n"
+        part << "\r\n"
+        part << "#{value}\r\n"
+      end
+    end
+  end
+end

data/lib/force/version.rb

@@ -0,0 +1,3 @@
+module Force
+  VERSION = '0.0.1'
+end

data/spec/fixtures/auth_error_response.json

@@ -0,0 +1,4 @@
+{
+  "error": "invalid_grant",
+  "error_description": "authentication failure - Invalid Password"
+}

data/spec/fixtures/auth_success_response.json

@@ -0,0 +1,7 @@
+{
+  "id": "https://login.salesforce.com/id/00Dx0000000BV7z/005x00000012Q9P",
+  "issued_at": "1278448832702",
+  "instance_url": "https://na1.salesforce.com",
+  "signature": "0CmxinZir53Yex7nE0TD+zMpvIWYGb/bdJh6XfOH6EQ=",
+  "access_token": "00Dx0000000BV7z!AR8AQAxo9UfVkh8AlV0Gomt9Czx9LjHnSSpwBMmbRcgKFmxOtvxjTrKW19ye6PE3Ds1eQz3z8jr3W7_VbWmEu4Q8TVGSTHxs"
+}

data/spec/fixtures/expired_session_response.json

@@ -0,0 +1,6 @@
+[
+  {
+    "message": "Session expired or invalid",
+    "errorCode": "INVALID_SESSION_ID"
+  }
+]

data/spec/fixtures/reauth_success_response.json

@@ -0,0 +1,7 @@
+{
+  "id": "https://login.salesforce.com/id/foo/bar",
+  "issued_at": "1309974610026",
+  "instance_url": "https://na1.salesforce.com",
+  "signature": "sig=",
+  "access_token": "new_access_token"
+}

data/spec/fixtures/refresh_error_response.json

@@ -0,0 +1,4 @@
+{
+  "error": "invalid_grant",
+  "error_description": "expired access/refresh token"
+}

data/spec/fixtures/refresh_success_response.json

@@ -0,0 +1,7 @@
+{
+  "id": "https://login.salesforce.com/id/foo/bar",
+  "issued_at": "1309974610026",
+  "instance_url": "https://na1.salesforce.com",
+  "signature": "sig=",
+  "access_token": "refreshed_access_token"
+}

data/spec/fixtures/services_data_success_response.json

@@ -0,0 +1,12 @@
+[
+  {
+    "version": "20.0",
+    "url": "/services/data/v20.0",
+    "label": "Winter '11"
+  },
+  {
+    "version": "100",
+    "url": "/services/data/v100",
+    "label": "Spring '86"
+  }
+]

data/spec/fixtures/sobject/create_success_response.json

@@ -0,0 +1,5 @@
+{
+    "id" : "some_id",
+    "errors" : [ ],
+    "success" : true
+}

data/spec/fixtures/sobject/delete_error_response.json

@@ -0,0 +1 @@
+[{"message":"Provided external ID field does not exist or is not accessible: rid","errorCode":"NOT_FOUND"}]

data/spec/fixtures/sobject/describe_sobjects_success_response.json

@@ -0,0 +1,31 @@
+{
+  "encoding" : "UTF-8",
+  "maxBatchSize" : 200,
+  "sobjects" : [ {
+    "name" : "Account",
+    "label" : "Account",
+    "custom" : false,
+    "keyPrefix" : "001",
+    "labelPlural" : "Accounts",
+    "layoutable" : true,
+    "activateable" : false,
+    "updateable" : true,
+    "urls" : {
+      "sobject" : "/services/data/v23.0/sobjects/Account",
+      "describe" : "/services/data/v23.0/sobjects/Account/describe",
+      "rowTemplate" : "/services/data/v23.0/sobjects/Account/{ID}"
+    },
+    "searchable" : true,
+    "createable" : true,
+    "customSetting" : false,
+    "deletable" : true,
+    "deprecatedAndHidden" : false,
+    "feedEnabled" : true,
+    "mergeable" : true,
+    "queryable" : true,
+    "replicateable" : true,
+    "retrieveable" : true,
+    "undeletable" : true,
+    "triggerable" : true
+  }]
+}

data/spec/fixtures/sobject/list_sobjects_success_response.json

@@ -0,0 +1,31 @@
+{
+  "encoding" : "UTF-8",
+  "maxBatchSize" : 200,
+  "sobjects" : [ {
+    "name" : "Account",
+    "label" : "Account",
+    "custom" : false,
+    "keyPrefix" : "001",
+    "labelPlural" : "Accounts",
+    "layoutable" : true,
+    "activateable" : false,
+    "updateable" : true,
+    "urls" : {
+      "sobject" : "/services/data/v23.0/sobjects/Account",
+      "describe" : "/services/data/v23.0/sobjects/Account/describe",
+      "rowTemplate" : "/services/data/v23.0/sobjects/Account/{ID}"
+    },
+    "searchable" : true,
+    "createable" : true,
+    "customSetting" : false,
+    "deletable" : true,
+    "deprecatedAndHidden" : false,
+    "feedEnabled" : true,
+    "mergeable" : true,
+    "queryable" : true,
+    "replicateable" : true,
+    "retrieveable" : true,
+    "undeletable" : true,
+    "triggerable" : true
+  }]
+}

data/spec/fixtures/sobject/org_query_response.json

@@ -0,0 +1,11 @@
+{
+  "totalSize" : 1,
+  "done" : true,
+  "records" : [ {
+    "attributes" : {
+      "type" : "Organization",
+      "url" : "/services/data/v20.0/sobjects/Organization/00Dx0000000BV7z"
+    },
+    "Id" : "00Dx0000000BV7z"
+  } ]
+}

data/spec/fixtures/sobject/query_aggregate_success_response.json

@@ -0,0 +1,23 @@
+{
+  "totalSize" : 3,
+  "done" : true,
+  "records" : [ {
+    "attributes" : {
+      "type" : "AggregateResult"
+    },
+    "CampaignId" : "701E0000000JuFHIA0",
+    "expr0" : 300.0
+  }, {
+    "attributes" : {
+      "type" : "AggregateResult"
+    },
+    "CampaignId" : "701E00000005ZqAIAU",
+    "expr0" : 100.0
+  }, {
+    "attributes" : {
+      "type" : "AggregateResult"
+    },
+    "CampaignId" : null,
+    "expr0" : 400
+  } ]
+}

data/spec/fixtures/sobject/query_empty_response.json

@@ -0,0 +1,5 @@
+{
+  "totalSize" : 0,
+  "done" : true,
+  "records" : [  ]
+}

data/spec/fixtures/sobject/query_error_response.json

@@ -0,0 +1,6 @@
+[
+  {
+    "message": "error_message",
+    "errorCode": "INVALID_FIELD"
+  }
+]

data/spec/fixtures/sobject/query_paginated_first_page_response.json

@@ -0,0 +1,14 @@
+{
+  "totalSize" : 2,
+  "done" : false,
+  "nextRecordsUrl" : "/services/data/v26.0/query/01gD",
+  "records" : [ 
+    {
+      "attributes" : {
+        "type" : "Whizbang",
+        "url" : "/services/data/v20.0/sobjects/Whizbang/foo"
+      },
+      "Text_Label" : "First Page"
+    } 
+  ]
+}

data/spec/fixtures/sobject/query_paginated_last_page_response.json

@@ -0,0 +1,13 @@
+{
+  "totalSize" : 2,
+  "done" : true,
+  "records" : [ 
+    {
+      "attributes" : {
+        "type" : "Whizbang",
+        "url" : "/services/data/v20.0/sobjects/Whizbang/foo"
+      },
+      "Text_Label" : "Last Page"
+    } 
+  ]
+}

data/spec/fixtures/sobject/query_success_response.json

@@ -0,0 +1,38 @@
+{
+  "totalSize": 1,
+  "done": true,
+  "records": [
+    {
+      "attributes": {
+        "type": "Whizbang",
+        "url": "/services/data/v20.0/sobjects/Whizbang/foo"
+      },
+      "Checkbox_Label": false,
+      "Text_Label": "Hi there!",
+      "Date_Label": "2010-01-01",
+      "DateTime_Label": "2011-07-07T00:37:00.000+0000",
+      "Picklist_Multiselect_Label": "four;six",
+      "ParentWhizbang__r": {
+        "Name": "Parent Whizbang",
+        "Text_Label": "Hello",
+        "attributes": {
+          "type": "Whizbang",
+          "url": "/services/data/v20.0/sobjects/Whizbang/bar"
+        }
+      },
+      "Whizbangs__r": {
+        "totalSize": 1,
+        "done": true,
+        "records": [
+          {
+            "attributes": {
+              "type": "Whizbang__c",
+              "url": "/services/data/v24.0/sobjects/Whizbang__c/a00E0000004D5lsIAC"
+            },
+            "Name": "Child Whizbang"
+          }
+        ]
+      }
+    }
+  ]
+}

data/spec/fixtures/sobject/recent_success_response.json

@@ -0,0 +1,18 @@
+[
+  {
+    "attributes": {
+      "type": "Whizbang",
+      "url": "/services/data/v23.0/sobjects/Whizbang/foo"
+    },
+    "Id": "foo",
+    "Name": "whatever"
+  },
+  {
+    "attributes": {
+      "type": "Whizbang",
+      "url": "/services/data/v23.0/sobjects/Whizbang/bar"
+    },
+    "Id": "bar",
+    "Name": "whatever"
+  }
+]

data/spec/fixtures/sobject/search_error_response.json

@@ -0,0 +1,6 @@
+[
+  {
+    "message": "No search term found. The search term must be enclosed in braces.",
+    "errorCode": "MALFORMED_SEARCH"
+  }
+]