sf_integrator 0.0.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 098462d10d0ed108233318ffbae543a560d0f5dd
-  data.tar.gz: f4a93f4091750d46949f1153efbe3b95096f0240
+  metadata.gz: bffccaca92dbd74e24436fe478ecd36a2e4fcc7d
+  data.tar.gz: a55fb45ea02b2f25cf709f3e4311723fb43aa964
 SHA512:
-  metadata.gz: 1b5ac75954787d51e035683ea6c2a7919aea9cb946b6e2629b738bfc19d85d689214ba0e3b9af8407348b7824147a473ac73068e2568c4412814cc4ab4db7c37
-  data.tar.gz: cecf0cae644586d15efc66e240936c16b978df5d6dd032b30286fdf5531454c8933333079128acd87d60ba9e893ad174faf655d5bc8e38fa25ff981c59d4f7f0
+  metadata.gz: 693aff9780a97e9d454a6a615d37e940528522979f7367663f6384ce5e4b2715e423c334179034e1a383a6a9e36608a901d45dbcc835e2d8b383d9ccc51e7743
+  data.tar.gz: ae3055a74642e8658c13691b3ac6d2cf41a247bd1a544549ae083f970d0ded5d0e01c2ad3db060afe350131cbbe170a9c688a0ee4ac73b37be04c58c2384ae2c

data/README.md

@@ -1,6 +1,6 @@
 # SfIntegrator
 
-Simple gem to integration with SalesForce Leads.
+TODO: Write a gem description
 
 ## Installation
 
@@ -16,23 +16,50 @@ Or install it yourself as:
 
     $ gem install sf_integrator
 
-## Usage
+## Configuration
 
-Run the generator:
+First, create a new file in called `sf_integrator.rb` in `config/initializers` path.
 
-`rails g sf_integrator:install`
+In this file, you put this configs:
 
-This command will copy a template file to `app/config/initializers/sf_integrator.rb`, in this file you need to write your credentials from salesforce
+```ruby
+SfIntegrator::Integrator.configure do |config|
+  config.username = 'YOUR_SALESFORCE_EMAIL'
+  config.password = 'YOUR_SALESFORCE_PASSWORD + YOUR_SALESFORCE_SECURITY_TOKEN'
+  config.client_id = 'YOUR_CUSTOMER_KEY'
+  config.client_secret = 'YOUR_CLIENT_SECRET'
+end
+```
 
-After that you create a simples ruby class that inherits from `SfIntegrator::Lead`:
+## Usage
+
+After that you create a simple ruby class in `models` directory that inherits from `SfIntegrator::Lead`
 
 ```ruby
 class Lead < SfIntegrator::Lead
 end
 ```
 
-Now in your controller you can use like a `ActiveRecord` model, the `SfIntegrator::Lead` include `ActiveModel::Validations`.
+In you controller you can use like a `ActiveRecord` model
+
+```ruby
+  # app/controllers/leads_controller.rb
+
+  def index
+    @leads = Lead.all
+  end
+  def new
+    @lead = Lead.new
+  end
+
+  def create
+    params = { first_name: 'Cezer', last_name: 'Filho', email: 'luiz.cezer@yahoo.com.br', company: 'Google', job_title: 'Developer', phone: '5555555', website: 'http://github.com/lccezinha' }
+    @lead = Lead.new(params)
+    @lead.create
+  end
+```
 
+The fields `first_name, last_name, email, company, job_title, phone, website` are all required.
 
 ## Contributing
 

data/lib/sf_integrator/lead.rb

@@ -6,21 +6,41 @@ module SfIntegrator
 
     validates :first_name, :last_name, :email, :company, :job_title, :phone, :website, presence: true
 
-    attr_accessor :client, :first_name, :last_name, :email, :company, :job_title, :phone, :website
-
-    def initialize
-      @client = Restforce.new(SfIntegrator::Integrator.configs.to_hash)
+    attr_accessor :first_name, :last_name, :email, :company, :job_title, :phone, :website
+
+    def initialize(args)
+      @first_name = args[:first_name]
+      @last_name  = args[:last_name]
+      @email      = args[:email]
+      @company    = args[:company]
+      @job_title  = args[:job_title]
+      @phone      = args[:phone]
+      @website    = args[:website]
     end
 
     def create
-      params = build_params
-      client.create('Lead', params)
+      params = {
+        FirstName: first_name, LastName: last_name, Email: email,
+        Company: company, Title: job_title, Phone: phone, Website: website
+      }
+      self.class.client.create('Lead', params)
+    end
+
+    def self.all
+      records = client.query('select FirstName, LastName, Email, Company, Title, Phone, Website from Lead')
+      records.map do |record|
+        attributes = {
+          first_name: record.FirstName, last_name: record.LastName, email: record.Email,
+          company: record.Company, job_title: record.Title, phone: record.Phone, website: record.Website
+        }
+        Lead.new(attributes)
+      end
     end
 
     private
 
-    def build_params
-      { FirstName: first_name, LastName: last_name, Email: email, Company: company, Title: job_title, Phone: phone, Website: website }
+    def self.client
+      @client ||= Restforce.new(SfIntegrator::Integrator.configs.to_hash)
     end
 
   end

data/lib/sf_integrator/version.rb

@@ -1,3 +1,3 @@
 module SfIntegrator
-  VERSION = "0.0.9"
+  VERSION = "1.0.0"
 end

data/lib/sf_integrator.rb

@@ -1,4 +1,3 @@
-require "sf_integrator/engine"
 require "sf_integrator/version"
 require "sf_integrator/configuration"
 require "sf_integrator/integrator"

data/sf_integrator.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'restforce', '1.4.3'
-  spec.add_runtime_dependency "activemodel"
+  spec.add_runtime_dependency "activemodel", '~> 0'
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", '~> 0'
+  spec.add_development_dependency "rspec", '~> 0'
 end

data/spec/integrator_spec.rb

@@ -14,9 +14,9 @@ describe SfIntegrator::Integrator do
       end
     end
 
-    it { expect(subject.instance.configs.username).to eql('lccezinha@gmail.com') }
-    it { expect(subject.instance.configs.password).to eql('batata880AvOSHd43zql8ZIMJ1emQNjkt') }
-    it { expect(subject.instance.configs.client_id).to eql('3MVG9xOCXq4ID1uFbfzoMHMM0bGJfUgjThmhEmajKOh75cvDlJn.E3g5FYx2R45vTpFRJfiPDfda5o.td8HQ2') }
-    it { expect(subject.instance.configs.client_secret).to eql('3340784302062558262') }
+    it { expect(subject.configs.username).to eql('lccezinha@gmail.com') }
+    it { expect(subject.configs.password).to eql('batata880AvOSHd43zql8ZIMJ1emQNjkt') }
+    it { expect(subject.configs.client_id).to eql('3MVG9xOCXq4ID1uFbfzoMHMM0bGJfUgjThmhEmajKOh75cvDlJn.E3g5FYx2R45vTpFRJfiPDfda5o.td8HQ2') }
+    it { expect(subject.configs.client_secret).to eql('3340784302062558262') }
   end
 end

data/spec/lead_spec.rb

@@ -2,7 +2,10 @@ require 'spec_helper'
 require_relative '../lib/sf_integrator/lead.rb'
 
 describe SfIntegrator::Lead do
-  subject(:lead) { described_class.new }
+  let(:attributes) {
+    { first_name: 'Cezer', last_name: 'Filho', email: 'luiz.cezer@yahoo.com.br', company: 'Google', job_title: 'Developer', phone: '5555555', website: 'http://github.com/lccezinha' }
+  }
+  subject(:lead) { described_class.new(attributes) }
 
   context 'be instance of SfIntegrator::Lead' do
     it { expect(lead).to be_an_instance_of(SfIntegrator::Lead) }
@@ -11,7 +14,7 @@ describe SfIntegrator::Lead do
   it { expect(described_class.ancestors).to include(ActiveModel::Validations) }
 
   context 'accessors' do
-    [:client, :first_name, :last_name, :email, :company, :job_title, :phone, :website].each do |attribute|
+    [:first_name, :last_name, :email, :company, :job_title, :phone, :website].each do |attribute|
       context attribute.to_s do
         it { expect(lead).to respond_to attribute }
         it { expect(lead).to respond_to "#{attribute}=" }
@@ -19,6 +22,16 @@ describe SfIntegrator::Lead do
     end
   end
 
+  it 'match values' do
+    expect(lead.first_name).to eql('Cezer')
+    expect(lead.last_name).to eql('Filho')
+    expect(lead.email).to eql('luiz.cezer@yahoo.com.br')
+    expect(lead.company).to eql('Google')
+    expect(lead.job_title).to eql('Developer')
+    expect(lead.phone).to eql('5555555')
+    expect(lead.website).to eql('http://github.com/lccezinha')
+  end
+
   context 'validations' do
     context 'presence_of' do
       [:first_name, :last_name, :email, :company, :job_title, :phone, :website].each do |attribute|
@@ -31,36 +44,17 @@ describe SfIntegrator::Lead do
   end
 
   it { expect(lead).to respond_to(:create) }
+  it { expect(described_class).to respond_to(:all) }
 
-  it 'match values' do
-    lead.first_name = 'Luiz'
-    lead.last_name  = 'Cezer'
-    lead.email = 'lccezinha@gmail.com'
-    lead.company = 'Google'
-    lead.job_title = 'Rails Dev'
-    lead.phone = '5555555'
-    lead.website = 'github.com/lccezinha'
-
-    expect(lead.first_name).to eql('Luiz')
-    expect(lead.last_name).to eql('Cezer')
-    expect(lead.email).to eql('lccezinha@gmail.com')
-    expect(lead.company).to eql('Google')
-    expect(lead.job_title).to eql('Rails Dev')
-    expect(lead.phone).to eql('5555555')
-    expect(lead.website).to eql('github.com/lccezinha')
+  context '#all' do
+    it 'return an array' do
+      expect(SfIntegrator::Lead.all).to be_an_instance_of(Array)
+    end
   end
 
   context 'create new lead' do
     context 'when success' do
       it do
-        lead.first_name = 'Cezer'
-        lead.last_name  = 'Filho'
-        lead.email = 'luiz.cezer@gmail.com'
-        lead.company = 'Google'
-        lead.job_title = 'Rails Dev'
-        lead.phone = '5555555'
-        lead.website = 'http://github.com/lccezinha'
-
         result = lead.create
 
         expect(result).to match(/[a-z]|[A-Z]|[0-9]/)
@@ -68,10 +62,10 @@ describe SfIntegrator::Lead do
     end
 
     context 'when fail' do
+      let(:attributes) { { first_name: 'Cezer' } }
+      subject(:fail_lead) { described_class.new(attributes) }
       it do
-        lead.first_name = 'Luiz'
-
-        result = lead.create
+        result = fail_lead.create
 
         expect(result).to eq(false)
       end

data/spec/version_spec.rb

@@ -2,5 +2,5 @@ require 'spec_helper'
 
 # just testing if rspec is ok
 describe SfIntegrator::VERSION do
-  it { expect(SfIntegrator::VERSION).to eq('0.0.1') }
+  it { expect(SfIntegrator::VERSION).to eq('1.0.0') }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sf_integrator
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Luiz Cezer
@@ -28,14 +28,14 @@ dependencies:
   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
@@ -56,28 +56,28 @@ dependencies:
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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: ' Integration with Sales Force leads. '
@@ -93,11 +93,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/generators/sf_integrator/install_generator.rb
-- lib/generators/sf_integrator/templates/sf_integrator.rb
 - lib/sf_integrator.rb
 - lib/sf_integrator/configuration.rb
-- lib/sf_integrator/engine.rb
 - lib/sf_integrator/integrator.rb
 - lib/sf_integrator/lead.rb
 - lib/sf_integrator/version.rb
@@ -127,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Integration with Sales Force leads.

data/lib/generators/sf_integrator/install_generator.rb

@@ -1,9 +0,0 @@
-module SfIntegrator
-  class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path("../templates", __FILE__)
-
-    def copy_initializer
-      template 'sf_integrator.rb', 'config/initializers/sf_integrator.rb'
-    end
-  end
-end

data/lib/generators/sf_integrator/templates/sf_integrator.rb

@@ -1,6 +0,0 @@
-SfIntegrator::Integrator.configure do |config|
-  config.username      = 'YOUR_EMAIL_FROM_SALESFORCE_ACCOUNT'
-  config.password      = 'YOUR_PASSWORD_FROM_SALESFORCE+YOUR_SECURITY_TOKEN'
-  config.client_id     = 'YOUR_APP_CUSTOMER_KEY'
-  config.client_secret = 'YOUR_APP_CUSTOMER_SECRET'
-end

data/lib/sf_integrator/engine.rb

@@ -1,4 +0,0 @@
-module SfIntegrator
-  class Engine < ::Rails::Engine
-  end
-end