bulkforce 1.0.0

data/lib/bulkforce/version.rb

@@ -0,0 +1,3 @@
+class Bulkforce
+  VERSION = "1.0.0"
+end

data/spec/integration/delete_spec.rb

@@ -0,0 +1,18 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe "Bulk Delete", type: :integration do
+  let!(:result) { delete_contacts }
+
+  it "returns a Hash" do
+    expect(result).to be_a(Hash)
+  end
+
+  it "sets state to 'Completed'" do
+    expect(result[:state]).to eq("Completed")
+  end
+
+  it "has no failed records" do
+    expect(result[:number_records_failed]).to eq("0")
+  end
+end

data/spec/integration/insert_spec.rb

@@ -0,0 +1,22 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe "Bulk Insert", type: :integration do
+  let!(:result) { insert_contacts }
+
+  it "returns a Hash" do
+    expect(result).to be_a(Hash)
+  end
+
+  it "sets state to 'Completed'" do
+    expect(result[:state]).to eq("Completed")
+  end
+
+  it "sets correct number of records processed" do
+    expect(result[:number_records_processed]).to eq("2")
+  end
+
+  it "has no failed records" do
+    expect(result[:number_records_failed]).to eq("0")
+  end
+end

data/spec/integration/query_spec.rb

@@ -0,0 +1,25 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe "Bulk Query", type: :integration do
+  let!(:result) { client.query("Contact", "select Id from Contact limit 10").freeze }
+
+  let(:size) { 10 }
+
+  it "returns a hash" do
+    expect(result).to be_a(Hash)
+  end
+
+  it "state is 'Completed'" do
+    expect(result[:state]).to eq("Completed")
+  end
+
+
+  it "returns an array of results" do
+    expect(result[:results]).to be_a(Array)
+  end
+
+  it "has correct size of results" do
+    expect(result[:results].count).to eq(size)
+  end
+end

data/spec/integration/update_spec.rb

@@ -0,0 +1,18 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe "Bulk Update", type: :integration do
+  let!(:result) { update_contacts }
+
+  it "returns a Hash" do
+    expect(result).to be_a(Hash)
+  end
+
+  it "sets state to 'Completed'" do
+    expect(result[:state]).to eq("Completed")
+  end
+
+  it "has no failed records" do
+    expect(result[:number_records_failed]).to eq("0")
+  end
+end

data/spec/integration/upsert_spec.rb

@@ -0,0 +1,22 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe "Bulk Upsert", type: :integration do
+  let!(:result) { upsert_contacts; upsert_contacts }
+
+  it "returns a Hash" do
+    expect(result).to be_a(Hash)
+  end
+
+  it "sets state to 'Completed'" do
+    expect(result[:state]).to eq("Completed")
+  end
+
+  it "sets correct number of records processed" do
+    expect(result[:number_records_processed]).to eq("2")
+  end
+
+  it "has no failed records" do
+    expect(result[:number_records_failed]).to eq("0")
+  end
+end

data/spec/lib/bulkforce/batch_spec.rb

@@ -0,0 +1,128 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe Bulkforce::Batch do
+  describe "#final_status" do
+    it "returns the final status if it already exists" do
+      b = described_class.new nil, nil, nil
+      expected_status = {w: :tf}
+      expect(b).not_to receive(:status)
+      b.instance_variable_set "@final_status", expected_status
+      expect(b.final_status).to eq(expected_status)
+    end
+
+    it "returns specific final status for -1 batch id" do
+      b = described_class.new nil, nil, -1
+      expected_status = {
+          state: "Completed",
+          state_message: "Empty Request",
+        }
+      expect(b).not_to receive(:status)
+      expect(b.final_status).to eq(expected_status)
+    end
+
+    it "queries the status correctly" do
+      b = described_class.new nil, nil, nil
+      expect(b).to receive(:status).once.and_return({w: :tf})
+      # TODO lookup the actual result
+      expect(b).to receive(:results).once.and_return({g: :tfo})
+      expect(b.final_status).to eq({w: :tf, results: {g: :tfo}})
+    end
+
+    it "yields status correctly" do
+      expected_running_state = {
+          state: "InProgress"
+        }
+      expected_final_state = {
+          state: "Completed"
+        }
+      b = described_class.new nil, nil, nil
+      expect(b).to receive(:status).once.and_return(expected_running_state)
+      expect(b).to receive(:status).once.and_return(expected_running_state)
+      expect(b).to receive(:status).once.and_return(expected_final_state)
+      expect(b).to receive(:results).once.and_return({g: :tfo})
+      expect{|blk| b.final_status(0, &blk)}
+        .to yield_successive_args(expected_running_state, expected_final_state)
+    end
+
+    it "raises exception when batch fails" do
+      b = described_class.new nil, nil, nil
+      expected_error_message = "Generic Error Message"
+      expect(b).to receive(:status).once.and_return(
+        {
+          state: "Failed",
+          state_message: expected_error_message})
+      expect{b.final_status}
+        .to raise_error(StandardError, expected_error_message)
+    end
+  end
+
+  [:request, :result].each do |action|
+    let(:connection) { double("Bulkforce::Connection") }
+    let(:request_result) { "Generic Result/Request" }
+    describe "#raw_#{action}" do
+
+      it "sends correct messages to connection" do
+        b = described_class.new nil, nil, nil
+        b.instance_variable_set "@connection", connection
+        expect(connection).to receive(:"raw_#{action}").and_return(request_result)
+        expect(b.send(:"raw_#{action}")).to eq(request_result)
+      end
+    end
+  end
+
+  describe "#results" do
+    let(:job_id) { "12345" }
+    let(:batch_id) { "67890" }
+    let(:connection) { double("connection") }
+    subject {described_class.new connection, job_id, batch_id}
+
+    context "with a single page of results" do
+      let(:result_id) {"M75200000001Vgt"}
+      let(:single_result) {{:Id=>"M75200000001Vgt", :name=>"Joe"}}
+
+      it "returns the results" do
+        expect(connection).to receive(:query_batch_result_id).
+          with(job_id, batch_id).
+          and_return({:result => result_id})
+
+        expect(connection).to receive(:query_batch_result_data).
+          once.
+          with(job_id, batch_id, result_id).
+          and_return(single_result)
+
+        expect(subject.results).to eq([single_result])
+      end
+    end
+
+    context "with an array of page of results" do
+      let(:result_ids) {["M75200000001Vgt", "M76500000001Vgt", "M73400000001Vgt"]}
+      let(:multiple_results) {[{:Id=>"AAA11123", :name=>"Joe"},
+        {:Id=>"AAA11124", :name=>"Sam"},
+        {:Id=>"AAA11125", :name=>"Mike"}]}
+
+      it "returns concatenated results" do
+        expect(connection).to receive(:query_batch_result_id).
+          with(job_id, batch_id).
+          and_return({:result => result_ids})
+
+        expect(connection).to receive(:query_batch_result_data).
+          ordered.
+          with(job_id, batch_id, result_ids[0]).
+          and_return(multiple_results[0])
+
+        expect(connection).to receive(:query_batch_result_data).
+          ordered.
+          with(job_id, batch_id, result_ids[1]).
+          and_return(multiple_results[1])
+
+        expect(connection).to receive(:query_batch_result_data).
+          ordered.
+          with(job_id, batch_id, result_ids[2]).
+          and_return(multiple_results[2])
+
+        expect(subject.results).to eq(multiple_results)
+      end
+    end
+  end
+end

data/spec/lib/bulkforce/configuration_spec.rb

@@ -0,0 +1,121 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe Bulkforce::Configuration do
+  subject { described_class.new }
+
+  context "api_version" do
+    include_examples "configuration settings", name: :api_version, expected_default: "33.0", env_variable: "SALESFORCE_API_VERSION"
+  end
+
+  context "username" do
+    include_examples "configuration settings", name: :username, expected_default: nil, env_variable: "SALESFORCE_USERNAME"
+  end
+
+  context "password" do
+    include_examples "configuration settings", name: :password, expected_default: nil, env_variable: "SALESFORCE_PASSWORD"
+  end
+
+  context "security_token" do
+    include_examples "configuration settings", name: :security_token, expected_default: nil, env_variable: "SALESFORCE_SECURITY_TOKEN"
+  end
+
+  context "host" do
+    include_examples "configuration settings", name: :host, expected_default: "login.salesforce.com", env_variable: "SALESFORCE_HOST"
+  end
+
+  context "session_id" do
+    include_examples "configuration settings", name: :session_id, expected_default: nil, env_variable: "SALESFORCE_SESSION_ID"
+  end
+
+  context "instance" do
+    include_examples "configuration settings", name: :instance, expected_default: nil, env_variable: "SALESFORCE_INSTANCE"
+  end
+
+  context "client_id" do
+    include_examples "configuration settings", name: :client_id, expected_default: nil, env_variable: "SALESFORCE_CLIENT_ID"
+  end
+
+  context "client_secret" do
+    include_examples "configuration settings", name: :client_secret, expected_default: nil, env_variable: "SALESFORCE_CLIENT_SECRET"
+  end
+
+  context "refresh_token" do
+    include_examples "configuration settings", name: :refresh_token, expected_default: nil, env_variable: "SALESFORCE_REFRESH_TOKEN"
+  end
+
+  describe "#to_h" do
+    let(:api_version) { "configuration_spec_api_version" }
+    let(:username) { "configuration_spec_user" }
+    let(:password) { "configuration_spec_password" }
+    let(:security_token) { "configuration_spec_security_token" }
+    let(:host) { "configuration_spec_host" }
+    let(:session_id) { "00Dx0000000BV7z!AR8AQP0jITN80ESEsj5EbaZTFG0RNBaT1cyWk7TrqoDjoNIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4" }
+    let(:instance) { "eu2" }
+    let(:client_id) { "3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE&client_secret=1955279925675241571" }
+    let(:client_secret) { "3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE&client_secret=1955279925675241571" }
+    let(:refresh_token) { "Ytwns3AKGIlTka3v9f6Md4kvZsMA9xNgMqVWdaNvBkfUaE7N6TbyVGEZ5eazoHJsa9RVgC5YvdbmPGeSZQNe3A" }
+
+    context "all values set" do
+      subject do
+        described_class.new.tap do |c|
+          c.api_version= api_version
+          c.username = username
+          c.password = password
+          c.security_token = security_token
+          c.host = host
+          c.session_id = session_id
+          c.instance = instance
+          c.client_id = client_id
+          c.client_secret = client_secret
+          c.refresh_token = refresh_token
+        end
+      end
+
+      let(:expected_hash) do
+        {
+          api_version: api_version,
+          username: username,
+          password: password,
+          security_token: security_token,
+          host: host,
+          session_id: session_id,
+          instance: instance,
+          client_id: client_id,
+          client_secret: client_secret,
+          refresh_token: refresh_token,
+        }
+      end
+
+      it "converts to expected hash" do
+        expect(subject.to_h).to eq(expected_hash)
+      end
+    end
+
+    context "some values missing" do
+      subject do
+        described_class.new.tap do |c|
+          c.api_version= api_version
+          c.username = username
+          c.password = password
+          c.security_token = security_token
+          c.host = host
+        end
+      end
+
+      let(:expected_hash) do
+        {
+          api_version: api_version,
+          username: username,
+          password: password,
+          security_token: security_token,
+          host: host,
+        }
+      end
+
+      it "converts to expected hash" do
+        expect(subject.to_h).to eq(expected_hash)
+      end
+    end
+  end
+end

data/spec/lib/bulkforce/connection_builder_spec.rb

@@ -0,0 +1,114 @@
+#encoding: utf-8
+require "spec_helper"
+
+describe Bulkforce::ConnectionBuilder do
+  describe "#build" do
+    subject { described_class.new(options) }
+    let!(:session_id) { "org_id!session_id" }
+    let!(:instance) { "eu2" }
+
+    before(:each) do
+      allow(Bulkforce::Http).to receive(:login).and_return(session_id: "org_id!session_id", instance: "eu2")
+      allow(Bulkforce::Http).to receive(:oauth_login).and_return(session_id: "org_id!session_id", instance: "eu2")
+    end
+
+    let(:host) { "login.salesforce.com" }
+    let(:api_version) { "33.0" }
+    let(:connection) { subject.build }
+
+    context "username/password" do
+      let(:options) do
+        {
+          host: host,
+          username: username,
+          password: password,
+          security_token: security_token,
+          api_version: api_version,
+        }
+      end
+
+      let(:username) { "leif@home.com" }
+      let(:password) { "password" }
+      let(:security_token) { "security_token" }
+
+      it "returns a connection" do
+        expect(connection).to be_a(Bulkforce::Connection)
+      end
+
+      it "triggers login with username, password and security token" do
+        subject.build
+        expect(Bulkforce::Http).
+          to have_received(:login).
+          with(host, username, "#{password}#{security_token}", api_version)
+      end
+
+      it "builds connection with correct attributes", :aggregate_failures do
+        expect(connection.instance_variable_get("@session_id")).to eq(session_id)
+        expect(connection.instance_variable_get("@instance")).to eq(instance)
+        expect(connection.instance_variable_get("@api_version")).to eq(api_version)
+      end
+    end
+
+    context "session id" do
+      let(:options) do
+        {
+          host: host,
+          session_id: session_id,
+          instance: instance,
+          api_version: api_version,
+        }
+      end
+
+      let(:session_id) { "00Dx0000000BV7z!AR8AQP0jITN80ESEsj5EbaZTFG0RNBaT1cyWk7TrqoDjoNIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4" }
+      let(:instance) { "eu2" }
+
+      it "returns a connection" do
+        expect(subject.build).to be_a(Bulkforce::Connection)
+      end
+
+      it "does not trigger HTTP login workflow" do
+        subject.build
+        expect(Bulkforce::Http).not_to have_received(:login)
+      end
+
+      it "builds connection with correct attributes", :aggregate_failures do
+        expect(connection.instance_variable_get("@session_id")).to eq(session_id)
+        expect(connection.instance_variable_get("@instance")).to eq(instance)
+        expect(connection.instance_variable_get("@api_version")).to eq(api_version)
+      end
+    end
+
+    context "oauth refresh token" do
+      let(:options) do
+        {
+          host: host,
+          client_id: client_id,
+          client_secret: client_secret,
+          refresh_token: refresh_token,
+          api_version: api_version,
+        }
+      end
+
+      let(:client_id) { "3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE&client_secret=1955279925675241571" }
+      let(:client_secret) { "3MVG9lKcPoNINVBIPJjdw1J9LLM82HnFVVX19KY1uA5mu0QqEWhqKpoW3svG3XHrXDiCQjK1mdgAvhCscA9GE&client_secret=1955279925675241571" }
+      let(:refresh_token) { "Ytwns3AKGIlTka3v9f6Md4kvZsMA9xNgMqVWdaNvBkfUaE7N6TbyVGEZ5eazoHJsa9RVgC5YvdbmPGeSZQNe3A" }
+
+      it "returns a connection" do
+        expect(connection).to be_a(Bulkforce::Connection)
+      end
+
+      it "triggers login with username, password and security token" do
+        subject.build
+        expect(Bulkforce::Http).
+          to have_received(:oauth_login).
+          with(host, client_id, client_secret, refresh_token)
+      end
+
+      it "builds connection with correct attributes", :aggregate_failures do
+        expect(connection.instance_variable_get("@session_id")).to eq(session_id)
+        expect(connection.instance_variable_get("@instance")).to eq(instance)
+        expect(connection.instance_variable_get("@api_version")).to eq(api_version)
+      end
+    end
+  end
+end