rd-salesforce 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e0ccff61ad3e03e3168e82a7dfd37b3da8aaa05
+  data.tar.gz: 90f8a24f2c83e46cee04d52151f7dc8ec93de562
+SHA512:
+  metadata.gz: 674d28b8ca99aaf8cf95a95b54127c487c8bdff474da1d6b5f566b1feda92c005a2167d81acc4907f3a8cf8ae586fe3eeaffbaff6b8edd66b0393ff009411b78
+  data.tar.gz: 5999c4b43f99c270f148a2a3ae3eab7dbdb1bc0226648d243f24e8e3d49a893c915590b87fc4bdfa7e0287f68764ffc5a334a4549c50b1f8d5ff21b5d73bd6a6

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rd-salesforce.gemspec
+gemspec
+
+
+group :test do
+  gem "rspec"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jônatas Davi Paganini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jônatas Paganini
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# Rd::Salesforce
+
+Integrates with salesforce allowing to add people as leads.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rd-salesforce', git: "https://github.com/jonatas/rd-salesforce.git"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rd-salesforce https://github.com/jonatas/rd-salesforce.git
+
+## Usage
+
+These library consists basically in:
+
+* [client.rb](/lib/rd/salesforce/client.rb) - wraps the [RestForce api](https://github.com/ejholmes/restforce) and authentication info.
+* [person.rb](/lib/rd/salesforce/person.rb) - stores and validates the person/lead info
+
+### Setup a client
+
+You can use the same [RestForce params to authentication](https://github.com/ejholmes/restforce#oauth-token-authentication) to the client:
+
+
+```ruby
+@client = Rd::Salesforce::Client.new instance_url: "https://xx.salesforce.com",
+  oauth_token: "xxxxx...."
+```
+
+### Instance a person
+
+```ruby
+@person = Rd::Salesforce::Person.new
+@person.first_name = "Jônatas"
+@person.last_name = "Paganini"
+@person.email = "jonatasdp@gmail.com"
+```
+
+You can see all the attributes at [person.rb](/lib/rd/salesforce/person.rb).
+
+### Upload person to salesforce with the client
+
+```ruby
+@person.upload_to_salesforce! @client
+```
+
+## Setting up a different translation to salesforce fields
+
+You can manage/override the fields connection that will be sent to salesforce via managing the translate hash.
+
+
+```ruby
+Rd::Salesforce::Person.translate = {
+  :first_name => "First Name",
+  :last_name => "Last Name",
+  :email => "Email",
+  :company => "Company",
+  :website => "Website",
+  :job_title => "Title",
+  :phone => "Phone"
+}
+```
+
+Or simple avoid send one attribute.
+
+```ruby
+Rd::Salesforce::Person.translate.delete :job_title
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/jonatas/rd-salesforce/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rd/salesforce.rb

@@ -0,0 +1,9 @@
+require 'rd/salesforce/version'
+require 'rd/salesforce/client'
+require 'rd/salesforce/person'
+
+module Rd
+  module Salesforce
+    # Your code goes here...
+  end
+end

data/lib/rd/salesforce/client.rb

@@ -0,0 +1,38 @@
+require 'restforce'
+
+module Rd
+  module Salesforce
+    class Client
+      VALID_PARAMS = %i(oauth_token host instance_url)
+      def initialize params
+        raise ArgumentError.new("Invalid Params: #{params.inspect} not in #{VALID_PARAMS.inspect}") if not valid_params? params
+        @api = Restforce.new(params)
+      end
+
+      def save_lead(person)
+        if not person.valid?
+          raise ArgumentError.new("can't upload an invalid record to sales force. person is invalid: #{person.inspect}\n   #{person.errors.inspect}") 
+        end
+        if person.salesforce_id
+          @api.update!("Lead", person.salesforce_id, person.translate_attributes)
+        else
+          person.salesforce_id = @api.create!("Lead", person.translate_attributes)
+        end
+      end
+
+      def valid?
+        not @api.nil?
+      end
+
+      private
+
+        def valid_params? params
+          return false if not params or not params.is_a? Hash
+          params.each do |key,value|
+            return false if not VALID_PARAMS.include?(key)
+          end
+          true
+        end
+    end
+  end
+end

data/lib/rd/salesforce/person.rb

@@ -0,0 +1,70 @@
+require 'active_model'
+require 'active_support/core_ext'
+require 'validate_url'
+
+module Rd
+  module Salesforce
+
+    ##
+    # Basic structure to handle a contact.
+    # It stores and validates basic person info and +upload_to_salesforce!+
+    #
+
+    class Person
+      include ActiveModel::Model
+      include ActiveModel::Validations
+
+
+       cattr_accessor :translate
+
+       self.translate = {
+          :first_name => "FirstName",
+          :last_name => "LastName",
+          :email => "Email",
+          :company => "Company",
+          :website => "Website",
+          :job_title => "Title",
+          :phone => "Phone"
+      }
+
+
+
+      attr_accessor :first_name, :last_name, :email, :company, :job_title, :phone, :website
+      attr_accessor :salesforce_id
+
+
+      validates :first_name, :last_name, :email, presence: true
+      validates :email,  format: { with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i }
+      validates :first_name, :phone, length: {maximum: 40}
+      validates :last_name, :job_title, :email, length: {maximum: 80}
+      validates :company, length: {maximum: 50}
+      validates :website, url: {allow_nil: true}, length: {maximum: 255}
+
+      ##
+      # Uploads current person to salesforce.
+      #
+      # Raises ArgumentError if the +client+ is nil or client is invalid
+      # Raises StandardError if the current instance is invalid
+
+      def upload_to_salesforce!(client)
+        raise ArgumentError.new("client is nil") if not client
+        raise ArgumentError.new("client is invalid: #{client.inspect}") if not client.valid?
+        raise ArgumentError.new("client does not respond to :save_lead method. client: #{client.inspect}") if not client.respond_to? :save_lead
+
+        client.save_lead self
+      end
+
+      ##
+      # Translates person fields to salesforce Lead attributes.
+      # see more about Lead object at: https://www.salesforce.com/developer/docs/api/Content/sforce_api_objects_lead.htm
+
+      def translate_attributes
+        info = {}
+        translate.each do |attribute_name, label|
+          info[label] = send(attribute_name)
+        end
+        info
+      end
+    end
+  end
+end

data/lib/rd/salesforce/version.rb

@@ -0,0 +1,5 @@
+module Rd
+  module Salesforce
+    VERSION = "0.0.1"
+  end
+end

data/rd-salesforce.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rd/salesforce/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rd-salesforce"
+  spec.version       = Rd::Salesforce::VERSION
+  spec.authors       = ["Jônatas Paganini"]
+  spec.email         = ["jonatasdp@gmail.com"]
+  spec.summary       = %q{Integrates Person with salesforce as a Lead.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'restforce'
+  spec.add_dependency 'activemodel'
+  spec.add_dependency 'validate_url'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/spec/rd-salesforce_client_spec.rb

@@ -0,0 +1,26 @@
+require_relative "./spec_shared_behaviour"
+describe Rd::Salesforce::Client do
+
+  include_context "shared behaviour"
+
+  describe "configuration" do
+    it "allow multiple accounts" do
+      expect(auth_client).to be_a(Rd::Salesforce::Client)
+
+      second_auth_client = Rd::Salesforce::Client.new with_oauth.merge(host: "serious.host.com")
+      expect(second_auth_client).to be_a(Rd::Salesforce::Client)
+    end
+    it "validates input params" do
+      expect(
+        lambda {
+          invalid_keys = { with: "ERRORS", and: "NON SENSE keys and values" }
+          Rd::Salesforce::Client.new invalid_keys
+        }
+      ).to raise_error(ArgumentError)
+    end
+    it "can save a lead" do
+      expect(auth_client).to be_respond_to :save_lead
+    end
+
+  end
+end

data/spec/rd-salesforce_person_spec.rb

@@ -0,0 +1,77 @@
+require_relative "spec_shared_behaviour"
+describe Rd::Salesforce::Person do
+
+  include_context "shared behaviour"
+
+  let(:person){ Rd::Salesforce::Person.new valid_person_attributes }
+  let(:auth_client) { Rd::Salesforce::Client.new with_oauth }
+
+  describe "integrates with salesforce" do
+    it "new person" do
+      expect(person).to be_valid
+    end
+    it "only valid records" do
+      invalid_person = Rd::Salesforce::Person.new {}
+      expect(invalid_person).to_not be_valid
+    end
+    it "uploads returns true if the person is valid" do
+      expect(auth_client).to receive(:save_lead).with(person)
+      expect(person.upload_to_salesforce! auth_client)
+    end
+    it "do not uploads an invalid person" do
+      expect(
+        lambda do 
+          expect(person).to receive(:valid?).and_return(false)
+          person.upload_to_salesforce! auth_client
+        end
+      ).to raise_error(ArgumentError)
+    end
+    it "do not uploads with invalid client" do
+      expect(
+        lambda do
+          person.upload_to_salesforce! nil
+        end
+      ).to raise_error ArgumentError
+    end
+  end
+  it "has basic attributes" do
+    valid_person_attributes.each do |attr, expected_value|
+      expect(person.send(attr)).to eql(expected_value)
+    end
+  end
+  describe "know translate attributes" do
+    let (:translated_attributes) { person.translate_attributes }
+    it "converts job_title to Title" do
+      expect(translated_attributes).to have_key("Title")
+    end
+    it "uses camelized keys for all others fields" do
+      expected_keys = Rd::Salesforce::Person.translate.values
+      expected_keys.each do |expected_key|
+        expect(translated_attributes).to have_key expected_key
+      end
+    end
+  end
+  describe "validations" do
+    it "validate maximum size of each field" do
+      invalid_attributes = {}
+      valid_person_attributes.each do |name, value|
+        invalid_attributes[name] = value * 50 if value
+      end
+      invalid_person = Rd::Salesforce::Person.new invalid_attributes
+      expect(invalid_person).to_not be_valid
+      valid_person_attributes.each do |name, value|
+          expect(invalid_person.errors).to have_key name if value
+      end
+    end
+  end
+  describe "translations" do
+    it "can be overrided"  do
+      Rd::Salesforce::Person.translate = {:email => "FirstName"}
+      attributes = person.translate_attributes
+      expect(attributes).to eql("FirstName" => "jonatasdp@gmail.com")
+    end
+  end
+  it "uploading the object to " do
+    expect(person).to respond_to(:upload_to_salesforce!)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require_relative '../lib/rd/salesforce'
+require 'rspec/autorun'
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/spec_shared_behaviour.rb

@@ -0,0 +1,21 @@
+RSpec.shared_context "shared behaviour", :a => :b do
+
+  let(:valid_person_attributes) do
+    { first_name: "Jônatas",
+      last_name: "Paganini",
+      email: "jonatasdp@gmail.com",
+      company: nil,
+      job_title: "Developer",
+      phone: "+55 4699117879",
+      website: "http://ideia.me" }
+  end
+
+  let(:with_oauth) do
+    { host: 'test.salesforce.com',
+      oauth_token: '123MyAwesomeToken321',
+      instance_url: 'http://test.salesforce.com' }
+  end
+
+  let(:auth_client) { Rd::Salesforce::Client.new with_oauth }
+
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: rd-salesforce
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jônatas Paganini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: restforce
+  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: activemodel
+  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: validate_url
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- jonatasdp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rd/salesforce.rb
+- lib/rd/salesforce/client.rb
+- lib/rd/salesforce/person.rb
+- lib/rd/salesforce/version.rb
+- rd-salesforce.gemspec
+- spec/rd-salesforce_client_spec.rb
+- spec/rd-salesforce_person_spec.rb
+- spec/spec_helper.rb
+- spec/spec_shared_behaviour.rb
+homepage: ''
+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: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Integrates Person with salesforce as a Lead.
+test_files:
+- spec/rd-salesforce_client_spec.rb
+- spec/rd-salesforce_person_spec.rb
+- spec/spec_helper.rb
+- spec/spec_shared_behaviour.rb