bulkforce 1.0.0

data/spec/lib/bulkforce_spec.rb

@@ -0,0 +1,128 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe Bulkforce do
+  subject { described_class }
+  let(:client) { subject.new(username: nil, password: nil, security_token: nil) }
+  let!(:connection_builder_class) { class_spy("Bulkforce::ConnectionBuilder", new: connection_builder).as_stubbed_const }
+  let(:connection_builder) { instance_spy("Bulkforce::ConnectionBuilder", build: empty_connection) }
+
+  let(:empty_connection) { instance_spy("Bulkforce::Connection") }
+
+  let(:empty_batch) do
+    Object.new
+  end
+
+  before(:each) do
+    allow_any_instance_of(Bulkforce::ConnectionBuilder).to receive(:build).and_return(empty_connection)
+  end
+
+  {
+    upsert: [nil,[{"no" => "value"}], "upsert_id"],
+    update: [nil,[{"no" => "value"}]],
+    insert: [nil,[{"no" => "value"}]],
+    delete: [nil,[{"no" => "value"}]],
+  }.each do |method_name, values|
+    describe "##{method_name}" do
+      it "delegates to #start_job" do
+        s = client
+        expect(s).to receive(:start_job)
+          .with(method_name.to_s, *values)
+        s.send(method_name, *values)
+      end
+
+      it "triggers correct workflow" do
+        s = client
+        expect(empty_connection).to receive(:create_job).ordered
+        expect(empty_connection).to receive(:add_batch).ordered
+        expect(empty_connection).to receive(:close_job).ordered
+        res = s.send(method_name, *values)
+        expect(res).to be_a(Bulkforce::Batch)
+      end
+    end
+  end
+
+  describe "#query" do
+    it "triggers correct workflow" do
+        expect(Bulkforce::Batch)
+          .to receive(:new)
+        .and_return(empty_batch)
+
+      s = client
+      sobject_input = "sobject_stub"
+      query_input = "query_stub"
+      expect(empty_connection).to receive(:create_job).ordered
+      expect(empty_connection).to receive(:add_query).ordered
+      expect(empty_connection).to receive(:close_job).ordered
+      expect(empty_batch).to receive(:final_status).ordered
+      s.query(sobject_input, query_input)
+    end
+  end
+
+  describe "#configure" do
+    let(:api_version) { "spec_33.0" }
+    let(:username) { "spec_user" }
+    let(:password) { "spec_password" }
+    let(:security_token) { "spec_security_token" }
+    let(:host) { "spec_host" }
+
+    it "yields a configuration object" do
+      expect { |b| subject.configure(&b) }.to yield_with_args(an_instance_of(Bulkforce::Configuration))
+    end
+
+    it "passes correct values to connection builder", :aggregate_failures do
+      subject.configure do |config|
+        config.api_version = api_version
+        config.username = username
+        config.password = password
+        config.security_token = security_token
+        config.host = host
+      end
+      subject.new
+      expect(connection_builder_class).to have_received(:new).with(
+        api_version: api_version,
+        username: username,
+        password: password,
+        security_token: security_token,
+        host: host,
+      )
+    end
+  end
+
+  context "file upload" do
+    describe "#insert" do
+      prefix = Dir.tmpdir
+      FileUtils.touch("#{prefix}/attachment.pdf")
+      attachment_data = {
+        "ParentId" => "00Kk0001908kqkDEAQ",
+        "Name" => "attachment.pdf",
+        "Body" => File.new("#{prefix}/attachment.pdf")
+      }
+
+      {
+        upsert: [nil,[attachment_data.dup], "upsert_id"],
+        update: [nil,[attachment_data.dup]],
+        insert: [nil,[attachment_data.dup]],
+        delete: [nil,[attachment_data.dup]],
+      }.each do |method_name, values|
+        describe "##{method_name}" do
+          it "delegates to #start_job" do
+            s = client
+            expect(s).to receive(:start_job)
+              .with(method_name.to_s, *values)
+            s.send(method_name, *values)
+          end
+
+          it "triggers correct workflow" do
+            s = client
+            expect(empty_connection).to receive(:create_job).ordered
+            expect(empty_connection).to receive(:add_file_upload_batch).ordered
+            expect(empty_connection).to receive(:close_job).ordered
+            res = s.send(method_name, *values)
+            expect(res).to be_a(Bulkforce::Batch)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require "simplecov"
+require "coveralls"
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter "spec"
+end
+
+require "dotenv"
+require "bulkforce"
+require "webmock/rspec"
+
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.order = "random"
+  config.filter_run_excluding skip: true
+
+  config.include Integration::Operations, type: :integration
+
+  config.before(:each) do
+    ENV.delete_if {|k| k =~ /^SALESFORCE_/}
+  end
+
+  config.before(:example, type: :integration) do
+    Dotenv.load
+    WebMock.disable!
+  end
+end
+
+def client
+  Bulkforce.new
+end

data/spec/support/integration_helpers.rb

@@ -0,0 +1,64 @@
+module Integration
+  module Operations
+    def insert_contacts
+      client.insert(
+        "Contact", [
+          {
+            "FirstName" => "Leif",
+            "LastName" => "Propertybase",
+            "LeadSource" => "integration_test",
+            "Email" => "#{SecureRandom.hex(5)}@pba.io",
+          },
+          {
+            "FirstName" => "Peter",
+            "LastName" => "Propertybase",
+            "LeadSource" => "integration_test",
+            "Email" => "#{SecureRandom.hex(5)}@pba.io",
+          },
+        ]).final_status.freeze
+    end
+
+    def upsert_contacts
+      client.upsert(
+        "Contact",
+        [
+          {
+            "FirstName" => "Leif",
+            external_id => "leif_pba",
+            "LastName" => "Propertybase",
+            "LeadSource" => "integration_test",
+            "Email" => "#{SecureRandom.hex(5)}@pba.io",
+          },
+          {
+            "FirstName" => "Peter",
+            external_id => "peter_pba",
+            "LastName" => "Propertybase",
+            "LeadSource" => "integration_test",
+            "Email" => "#{SecureRandom.hex(5)}@pba.io",
+          },
+        ],
+        external_id,
+        ).final_status.freeze
+    end
+
+    def update_contacts
+      insert_contacts
+      all_contacts = query_all_test_contacts.map{|entry| entry.merge("FirstName" => "Updated") }
+      client.update("Contact", all_contacts).final_status.freeze
+    end
+
+    def delete_contacts
+      insert_contacts
+      all_contacts = query_all_test_contacts
+      client.delete("Contact", all_contacts).final_status.freeze
+    end
+
+    def query_all_test_contacts
+      client.query("Contact", "select Id from Contact where LeadSource = 'integration_test'")[:results]
+    end
+
+    def external_id
+      "pba__SystemExternalId__c"
+    end
+  end
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,21 @@
+shared_examples "configuration settings" do |name:, expected_default:, env_variable:|
+  it "has default for #{name} set to #{expected_default}" do
+    expect(subject.send(name.to_sym)).to eq(expected_default)
+  end
+
+  it "can set #{name} to custom value" do
+    subject.send("#{name}=".to_sym, "custom value")
+    expect(subject.send(name.to_sym)).to eq("custom value")
+  end
+
+  it "can overwrite the default value by ENV variable" do
+    ENV[env_variable] = "value by env"
+    expect(subject.send(name.to_sym)).to eq("value by env")
+  end
+
+  it "can overwrite env variable by custom value" do
+    ENV[env_variable] = "value by env"
+    subject.send("#{name}=".to_sym, "custom value overwrites env")
+    expect(subject.send(name.to_sym)).to eq("custom value overwrites env")
+  end
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: bulkforce
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jorge Valdivia
+- Leif Gensert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: This gem provides a super simple interface for the Salesforce Bulk API.
+  It provides support for insert, update, upsert, delete, and query.
+email:
+- jorge@valdivia.me
+- leif@propertybase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bulkforce.gemspec
+- lib/bulkforce.rb
+- lib/bulkforce/batch.rb
+- lib/bulkforce/configuration.rb
+- lib/bulkforce/connection.rb
+- lib/bulkforce/connection_builder.rb
+- lib/bulkforce/helper.rb
+- lib/bulkforce/http.rb
+- lib/bulkforce/version.rb
+- spec/integration/delete_spec.rb
+- spec/integration/insert_spec.rb
+- spec/integration/query_spec.rb
+- spec/integration/update_spec.rb
+- spec/integration/upsert_spec.rb
+- spec/lib/bulkforce/batch_spec.rb
+- spec/lib/bulkforce/configuration_spec.rb
+- spec/lib/bulkforce/connection_builder_spec.rb
+- spec/lib/bulkforce/connection_spec.rb
+- spec/lib/bulkforce/helper_spec.rb
+- spec/lib/bulkforce/http_spec.rb
+- spec/lib/bulkforce_spec.rb
+- spec/spec_helper.rb
+- spec/support/integration_helpers.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/propertybase/bulkforce
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: bulkforce
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby support for the Salesforce Bulk API
+test_files:
+- spec/integration/delete_spec.rb
+- spec/integration/insert_spec.rb
+- spec/integration/query_spec.rb
+- spec/integration/update_spec.rb
+- spec/integration/upsert_spec.rb
+- spec/lib/bulkforce/batch_spec.rb
+- spec/lib/bulkforce/configuration_spec.rb
+- spec/lib/bulkforce/connection_builder_spec.rb
+- spec/lib/bulkforce/connection_spec.rb
+- spec/lib/bulkforce/helper_spec.rb
+- spec/lib/bulkforce/http_spec.rb
+- spec/lib/bulkforce_spec.rb
+- spec/spec_helper.rb
+- spec/support/integration_helpers.rb
+- spec/support/shared_examples.rb