outreach 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 896ed42c45cb4f5764a88236b9fe427e3b1a0aa5
-  data.tar.gz: a957060f07a0a383da1c757ffff61d4ad11d15b6
+  metadata.gz: fe1c9b5714bb38174c441cb266cd46381aa3110d
+  data.tar.gz: b818c9939969cb205bcb7e86b76c7e7aa76817cb
 SHA512:
-  metadata.gz: 08d825b753f669009e5bd3ffc1952e8bc4bacd894e754f00a2ed7cc41ee874b8646bf72ef2974ca7fa1030b3a12a664c9fdce0c503b92caf1bc822ecaae0fae0
-  data.tar.gz: ba92fcf9533e4e3689d612692dd4b97d9d5c8f6fd8f030e933f5840d361932ced90f6a1134097440081d5ff4775d1f48a926e2c5790bd6c2ee2866d0143eecee
+  metadata.gz: 6e6766d6f9a6095003e293b30605dc68087c61a47014130aae05aba290f5c949c3c54d39ec00df5771c1cae6dc452046a6f1a627439b8037b36c6cd8f8bdf0d7
+  data.tar.gz: ffae74024011ff42c117d485811f663c31a75f7e8f05041f18b0353dc5f46c8fb782855bbbb97f7ce8d96f690edf1d26de40565b506223ca59ee5b6caefedae6

data/README.md

@@ -39,7 +39,7 @@ First off you need to grab the authorization key for your user. You do this by g
 
 For example, if using Rails this could be in a view
 ```
-  <%= link_to("Connect to Outreach", Outreach::Authorization.authorization_url)
+  <%= link_to("Connect to Outreach", Outreach::Authorization.authorization_url) %>
 ```
 
 This will take the user through the oauth process - afterwards they will be redirected back to your site to whatever the url you have setup in Outreach.redirect_uri.  This will also provide the authorization key so you can get access for that user using the Outreach::Authorization.create method.
@@ -77,13 +77,13 @@ user.save
 ## API Client
 Once you have the access code for a user you can then create an api client for that user.
 ```ruby
-  client = Outreach::Client.new(user.access_code)
+  outreach = Outreach::Client.new(user.access_code)
 ```
 
 ## Prospects
 To find all prospects:
 ```ruby
-  client.prospects.all
+  outreach.prospects.find_all
   # returns an array of prospects
 ```
 
@@ -94,17 +94,17 @@ Filtering is possible by using the following conditions:
   # email
   # company_name
   # e.g.
-  client.prospects.all({ first_name: "Chris", last_name: "O'Sullivan" })
+  outreach.prospects.find_all({ first_name: "Chris", last_name: "O'Sullivan" })
 ```
 
-The results of client.prospects.all is paginated. You can control pagination by passing in which page you want to see:
+The results of outreach.prospects.find_all is paginated. You can control pagination by passing in which page you want to see:
 ```ruby
-  client.prospects.all({ page: 2 })
+  outreach.prospects.find_all({ page: 2 })
 ```
 
 You can find a specific prospect given the prospect id:
 ```ruby
-  clients.prospect.find(2345)
+  outreach.prospects.find(2345)
 ```
 
 ## Contributing

data/lib/outreach/client.rb

@@ -4,12 +4,10 @@ module Outreach
       @api_token = api_token
     end
 
-    def prospect
-      Outreach::ProspectFinder.new(request)
+    def prospects
+      Outreach::Service::Prospect.new(self)
     end
 
-    private
-
     def request
       Request.new(@api_token)
     end

data/lib/outreach/prospect.rb

@@ -1,6 +1,6 @@
 module Outreach
   class Prospect
-    attr_accessor :first_name, :last_name, :company, :contact, :tags
+    attr_accessor :first_name, :last_name, :company, :contact, :tags, :id
 
     def initialize(attrs)
       @first_name = attrs['attributes']['personal']['name']['first']
@@ -8,6 +8,7 @@ module Outreach
       @company = to_ostruct(attrs['attributes']['company'])
       @contact = to_ostruct(attrs['attributes']['contact'])
       @tags = attrs['attributes']['metadata']['tags']
+      @id = attrs['id']
     end
 
     private
@@ -20,39 +21,5 @@ module Outreach
       o
     end
   end
-
-  class ProspectFinder
-    API_URL =  "https://api.outreach.io/1.0/prospects"
-
-    def initialize(request)
-      @request = request
-    end
-
-    def find(id)
-      response = @request.get("#{API_URL}/#{id}")
-      Prospect.new(response)
-    end
-
-    def all(attrs={})
-      response = @request.get(API_URL, attribute_mapping(attrs))
-      response['data'].map {|attrs| Prospect.new(attrs)}
-    end
-
-    private
-
-    def attribute_mapping(attrs)
-      if attrs[:first_name]
-        attrs["filter[personal/name/first]"] = attrs.delete(:first_name)
-      end
-      if attrs[:last_name]
-        attrs["filter[personal/name/last]"] = attrs.delete(:last_name)
-      end
-      attrs["filter[contact/email]"] = attrs.delete(:email) if attrs[:email]
-      if attrs[:company_name]
-        attrs["filter[company/name]"] = attrs.delete(company_name)
-      end
-      attrs
-    end
-  end
 end
 

data/lib/outreach/service/prospect.rb

@@ -0,0 +1,43 @@
+module Outreach
+  module Service
+    class Prospect
+      def initialize(client)
+        @request = client.request
+      end
+
+      def find(id)
+        response = @request.get("#{api_url}/#{id}")
+        collection_class.new(response['data'])
+      end
+
+      def find_all(attrs={})
+        response = @request.get(api_url, attribute_mapping(attrs))
+        response['data'].map {|attrs| collection_class.new(attrs)}
+      end
+
+      protected
+
+      def api_url
+        "https://api.outreach.io/1.0/prospects"
+      end
+
+      def collection_class
+        Outreach::Prospect
+      end
+
+      def attribute_mapping(attrs)
+        if attrs[:first_name]
+          attrs["filter[personal/name/first]"] = attrs.delete(:first_name)
+        end
+        if attrs[:last_name]
+          attrs["filter[personal/name/last]"] = attrs.delete(:last_name)
+        end
+        attrs["filter[contact/email]"] = attrs.delete(:email) if attrs[:email]
+        if attrs[:company_name]
+          attrs["filter[company/name]"] = attrs.delete(company_name)
+        end
+        attrs
+      end
+    end
+  end
+end

data/lib/outreach/version.rb

@@ -1,3 +1,3 @@
 module Outreach
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/outreach.rb

@@ -4,6 +4,7 @@ require "outreach/request"
 require "outreach/authorization"
 require "outreach/client"
 require "outreach/prospect"
+require "outreach/service/prospect"
 
 module Outreach
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outreach
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Chris O'Sullivan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2016-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,6 +114,7 @@ files:
 - lib/outreach/errors.rb
 - lib/outreach/prospect.rb
 - lib/outreach/request.rb
+- lib/outreach/service/prospect.rb
 - lib/outreach/version.rb
 - outreach.gemspec
 homepage: