rdstation-ruby-client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a473fed738ad5d11c6225ba2f358af8ffcd6c660
-  data.tar.gz: 7799b8c780d146562bd98ab98e332c77d6c3653b
+  metadata.gz: 241aecdc02ed1fd18142980cce941833e5af996b
+  data.tar.gz: 35d829695bba940e158422db66ff58870cdf4dde
 SHA512:
-  metadata.gz: f17a39e5d7d8d8e7bb3902c8ce614ceb9328dccb5a4310c3d4fe3165524511500ac92de81ecf2775944315ce2c405349c7a50247bd9114db3c72fadbc545571a
-  data.tar.gz: a09b497efe036197fc798d745d0f6da78fc4d7b06fa931ed5cf250903ecaba7550621b146827327984079b5cbe095d31cf27d3fbda09890bac474e29c1fafea6
+  metadata.gz: 580b88ecf5a5e1be41eeeac5555bd3223737e0998042ac6992d01f614e7e3b7e7700b440f89d08c8f7f6644a94344115724c6c4591f03e9483381aad2d6d267d
+  data.tar.gz: ddbcb332b035f78c97df8557271ff74b31b9a3be2b8ff605495913bcba8842b7d8328950eb241dc227514f55116fa39dcbcd1ab1ae6bcbd77d053998f1b23827

data/Gemfile.lock

@@ -1,18 +1,44 @@
 PATH
   remote: .
   specs:
-    rdstation-ruby-client (0.0.1)
+    rdstation-ruby-client (0.0.2)
       httparty (~> 0.12.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.3.7)
+    ansi (1.5.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
     httparty (0.12.0)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
-    json (1.8.1)
+    json (1.8.2)
+    minitest (4.7.5)
     multi_xml (0.5.5)
     rake (10.1.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    safe_yaml (1.0.4)
+    turn (0.9.7)
+      ansi
+      minitest (~> 4)
+    vcr (2.9.3)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
@@ -21,3 +47,7 @@ DEPENDENCIES
   bundler (~> 1.3)
   rake
   rdstation-ruby-client!
+  rspec
+  turn
+  vcr
+  webmock

data/README.md

@@ -6,7 +6,7 @@ TODO: Write a gem description
 
 Add this line to your application's Gemfile:
 
-    gem 'rdstation-ruby'
+    gem 'rdstation-ruby-client'
 
 And then execute:
 
@@ -14,11 +14,22 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install rdstation-ruby
+    $ gem install rdstation-ruby-client
 
 ## Usage
 
-TODO: Write usage instructions here
+### Creating a Lead
+    rdstation_client = RDStation::Client.new('rdstation_token', 'auth_token')
+    rdstation_client.create_lead({:email => 'joe@foo.bar', :nome => 'Joe Foo', :empresa => 'A random Company', :cargo => 'Developer', identificador: 'nome_da_conversao'})
+
+### Changing a Lead
+    rdstation_client = RDStation::Client.new('rdstation_token', 'auth_token')
+    rdstation_client.change_lead('joe@foo.bar', {:lifecycle_stage => 1, :opportunity => true})
+
+### Change Lead Status
+    rdstation_client = RDStation::Client.new('rdstation_token', 'auth_token')
+    rdstation_client.change_lead_status(email: 'joe@foo.bar', status: 'won', value: 999)
+
 
 ## Contributing
 
@@ -27,3 +38,12 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Reference
+
+You can check out RDstation's integration (pt-BR) documentation here:
+
+- [Pure HTML](https://gist.github.com/pedrobachiega/3298970);
+- [Wordpress & Contact Form 7](https://gist.github.com/pedrobachiega/3277536);
+- [PHP](https://gist.github.com/pedrobachiega/3248293);
+- [HTML+Ajax with jQuery](https://gist.github.com/pedrobachiega/3248013);

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/rdstation/client.rb

@@ -1,15 +1,78 @@
 module RDStation
+  #
+  # Mais informações em https://www.rdstation.com.br/docs/api
+  #
   class Client
     include HTTParty
-    base_uri "https://www.rdstation.com.br"
 
-    def initialize(token)
-      @token = token
+    def initialize(rdstation_token, auth_token, identifier="integração")
+      @identificador = identifier
+      @rdstation_token = rdstation_token
+      @auth_token = auth_token
     end
 
+    #
+    # A hash de lead pode conter os parametros
+    # (requerido)  :identificador
+    # (requerido)  :email
+    #              :nome
+    #              :empresa
+    #              :cargo
+    #              :telefone
+    #              :celular
+    #              :website
+    #              :twitter
+    #              :c_utmz
+    #
     def create_lead(lead_hash)
-      lead_hash = { :token_rdstation => @token, :identificador => "integração" }.merge(lead_hash)
-      self.class.post('/api/1.2/conversions', { :body => lead_hash })
+      lead_hash = rdstation_token_hash.merge(lead_hash)
+      lead_hash = lead_hash.merge(identifier_hash) unless lead_hash.has_key?(:identificador)
+      post_with_body("/conversions", {:body => lead_hash})
+    end
+
+    #
+    # param lead:
+    #   id ou email do Lead a ser alterado
+    #
+    # param lead_hash:
+    #   Hash contendo:
+    #     :lifecycle_stage
+    #       0 - Lead; 1 - Lead Qualificado; 2 - Cliente
+    #     :opportunity
+    #       true ou false
+    #
+    def change_lead(lead, lead_hash)
+      lead_hash = auth_token_hash.merge({:lead => lead_hash})
+      put_with_body("/leads/#{lead}", :body => lead_hash.to_json, :headers => {'Content-Type' => 'application/json'})
+    end
+
+    def change_lead_status(lead_hash)
+      post_with_body("/services/#{@auth_token}/generic", :body => lead_hash )
+    end
+
+  private
+    def base_url
+      "https://www.rdstation.com.br/api/1.2"
+    end
+
+    def rdstation_token_hash
+      { :token_rdstation => @rdstation_token }
+    end
+
+    def auth_token_hash
+      { :auth_token => @auth_token }
+    end
+
+    def identifier_hash
+      { :identificador => @identificador }
+    end
+
+    def post_with_body(path, opts)
+      self.class.post("#{base_url}#{path}", opts)
+    end
+
+    def put_with_body(path, opts)
+      self.class.put("#{base_url}#{path}", opts)
     end
   end
 end

data/lib/rdstation/version.rb

@@ -1,3 +1,3 @@
 module RDStation
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/rdstation-ruby-client.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["paulo.casaretto@resultadosdigitais.com.br"]
   spec.description   = "Ruby API wrapper for RD Station"
   spec.summary       = "Ruby API wrapper for RD Station"
-  spec.homepage      = ""
+  spec.homepage      = "http://resultadosdigitais.com.br"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -20,6 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'turn'
 
   spec.add_dependency "httparty", "~> 0.12.0"
 end

data/spec/lib/rdstation-ruby-client_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe RDStation do
+    let(:rdstation_client) { RDStation::Client.new('token','private' ) }
+    let(:lead_email) { "iginosms@gmail.com" }
+    let(:amount) { 300}
+
+
+  context "#change_lead_status" do
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rdstation-ruby-client'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+
+# RSpec.configure do |c|
+#   # so we can use :vcr rather than :vcr => true;
+#   # in RSpec 3 this will no longer be necessary.
+#   c.treat_symbols_as_metadata_keys_with_true_values = true
+# end

metadata

@@ -1,55 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  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: turn
+  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: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
 description: Ruby API wrapper for RD Station
@@ -59,7 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -69,7 +125,9 @@ files:
 - lib/rdstation/client.rb
 - lib/rdstation/version.rb
 - rdstation-ruby-client.gemspec
-homepage: ''
+- spec/lib/rdstation-ruby-client_spec.rb
+- spec/spec_helper.rb
+homepage: http://resultadosdigitais.com.br
 licenses:
 - MIT
 metadata: {}
@@ -79,18 +137,20 @@ 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.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby API wrapper for RD Station
-test_files: []
+test_files:
+- spec/lib/rdstation-ruby-client_spec.rb
+- spec/spec_helper.rb