sendgrid_webapi 0.0.2 → 0.1.2

data/lib/api_key/management.rb

@@ -0,0 +1,33 @@
+module SendGridWebApi::ApiKeyModules
+  class Management < SendGridWebApi::ApiKey
+    APIKEY_URL = "api_keys"
+
+    def get options = {}
+      management_get_url = APIKEY_URL
+      if options.key?(:apikey_id)
+        management_get_url += "/#{options[:apikey_id]}"
+        options.delete(:apikey_id)
+      end
+      query_api(management_get_url, process_header_options(options))
+    end
+
+    def create options = {}
+      query_post_json_api(APIKEY_URL, process_header_options(options))
+    end
+
+    def delete apikey_id, options = {}
+      query_delete_api(APIKEY_URL+"/#{apikey_id}", process_header_options(options))
+    end
+
+    def update apikey_id, options = {}
+      query_patch_api(APIKEY_URL+"/#{apikey_id}", process_header_options(options))
+    end
+
+    private
+    def process_header_options options
+      on_behalf_of = options.delete(:on_behalf_of)
+      options.merge!({ headers: { "on-behalf-of" => on_behalf_of } }) unless on_behalf_of.nil?
+      options
+    end
+  end
+end

data/lib/api_key/modules.rb

@@ -0,0 +1,10 @@
+#loading modules
+%w(management).each do |mod|
+  require "api_key/" + mod
+end
+
+module SendGridWebApi::ApiKeyModules
+  def management
+    @management_instance ||= Management.new(@api_key)
+  end
+end

data/lib/apikey_client.rb

@@ -0,0 +1,11 @@
+module SendGridWebApi
+  autoload :ApiKeyModules, 'api_key/modules'
+
+  class ApiKey < Base
+    include SendGridWebApi::ApiKeyModules
+
+    def base_url
+      "https://api.sendgrid.com/v3/"
+    end
+  end
+end

data/lib/base.rb

@@ -1,39 +1,73 @@
+require 'faraday_middleware'
+
 module SendGridWebApi
-  autoload :Faraday, 'middlewares/sendgrid_response'
-  
   class Base
-    attr_accessor :api_user, :api_key
+    attr_accessor :api_key
 
-    def initialize api_user, api_key
-      @api_user = api_user
+    def initialize api_key
       @api_key  = api_key
     end
-    
+
     def make_request_url url, options
       "#{url}?#{builder_options(options)}"
     end
 
     def builder_options options
-      options.merge!(:api_user => @api_user, :api_key => @api_key)
       to_query(options)
     end
 
     def query_api url, options
-      session.get(make_request_url(url, options)).body
+      headers = options.delete(:headers)
+      (session.get(make_request_url(url, options)) do |req|
+        req.headers.merge!(headers) unless headers.nil?
+      end).body
     end
 
     def query_post_api url, options
-      builder_options(options)
-      session.post(url, builder_options(options)).body
+      headers = options.delete(:headers)
+      (session.post(url, builder_options(options)) do |req|
+        req.headers.merge!(headers) unless headers.nil?
+      end).body
     end
-    
+
+    def query_post_json_api url, options
+      headers = options.delete(:headers)
+      (session.post(url) do |req|
+        req.headers[:content_type] = 'application/json'
+        req.headers.merge!(headers) unless headers.nil?
+        req.body = options.to_json
+      end).body
+    end
+
+    def query_patch_api url, options
+      headers = options.delete(:headers)
+      (session.patch(url) do |req|
+        req.headers[:content_type] = 'application/json'
+        req.headers.merge!(headers) unless headers.nil?
+        req.body = options.to_json
+      end).body
+    end
+
+    def query_delete_api url, options
+      headers = options.delete(:headers)
+      (session.delete(make_request_url(url, options)) do |req|
+        req.headers.merge!(headers) unless headers.nil?
+      end).body
+    end
+
     def to_query(options)
       Faraday::Utils.build_nested_query(options)
     end
 
     def session
-      @connection ||= ::Faraday.new base_url do |conn|
-        conn.use Faraday::Response::SendGridWebApi
+      @connection ||= ::Faraday.new(
+        url: base_url,
+        headers: {"Authorization" => "Bearer #{@api_key}"}
+      ) do |conn|
+        # Forces the connection request and response to be JSON even though
+        # Sendgrids API headers do not specify the content type is JSON
+        conn.request :url_encoded
+        conn.response :json #, :content_type => /\bjson$/
         conn.adapter Faraday.default_adapter
       end
     end

data/lib/helper.rb

@@ -1,33 +1,33 @@
 module SendGridWebApi::Helper
   extend self  
   
-  def run_sendgrid_query(username, password)
-    @client = SendGridWebApi::Client.new(username, password)
+  def run_sendgrid_query(apikey)
+    @client = SendGridWebApi::Client.new(apikey)
     result = yield
     raise "it returns the following errors: #{result}" unless result.eql?({"message"=>"success"})
   end
 
   ###this accepts subuser array
-  def create_sub_user_account(username, password, users)
+  def create_sub_user_account(apikey, users)
     users.each do |user, data|
       #load users
-      run_sendgrid_query(username, password) do
+      run_sendgrid_query(apikey) do
         @client.sub_user.management.add(data[:account].merge!(:username => user))
       end
             
       #active user for send email
-      run_sendgrid_query(username, password){@client.sub_user.management.enable(:user => user)}
+      run_sendgrid_query(apikey){@client.sub_user.management.enable(:user => user)}
     
       #assign ip
       unless data[:assigned_ips].empty?
-        run_sendgrid_query(username, password){@client.sub_user.ip_management.assign_ip :user => user, :ip => data[:assigned_ips]}
+        run_sendgrid_query(apikey){@client.sub_user.ip_management.assign_ip :user => user, :ip => data[:assigned_ips]}
       end
       #load apps
       unless data[:applications].empty?
         data[:applications].each do |app_name, options|
-          run_sendgrid_query(username, password){@client.sub_user.apps.activate(:user => user, :name => app_name)}
+          run_sendgrid_query(apikey){@client.sub_user.apps.activate(:user => user, :name => app_name)}
           unless options.empty?
-            run_sendgrid_query(username, password){@client.sub_user.apps.customize(options.merge!(:user => user, :name => app_name))}
+            run_sendgrid_query(apikey){@client.sub_user.apps.customize(options.merge!(:user => user, :name => app_name))}
           end
         end
       end

data/lib/sendgrid_webapi.rb

@@ -3,3 +3,4 @@ require 'base'
 require 'helper'
 require 'webapi_client'
 require 'subuser_client'
+require 'apikey_client'

data/lib/sub_user/modules.rb

@@ -6,63 +6,63 @@ end
 
 module SendGridWebApi::SubUserModules
   def management
-    @management_instance ||= Management.new(@api_user, @api_key)
+    @management_instance ||= Management.new(@api_key)
   end
 
   def bounces
-    @bounce_instance ||= Bounce.new(@api_user, @api_key)
+    @bounce_instance ||= Bounce.new(@api_key)
   end
 
   def unsubscribes
-    @unsubscribe_instance ||= Unsubscribe.new(@api_user, @api_key)
+    @unsubscribe_instance ||= Unsubscribe.new(@api_key)
   end
 
   def spam
-    @spam_instance ||= Spam.new(@api_user, @api_key)
+    @spam_instance ||= Spam.new(@api_key)
   end
 
   def invalid_emails
-    @invalid_email_instance ||= InvalidEmail.new(@api_user, @api_key)
+    @invalid_email_instance ||= InvalidEmail.new(@api_key)
   end
   
   def event_notification
-    @event_notification_instance ||= EventNotification.new(@api_user, @api_key)
+    @event_notification_instance ||= EventNotification.new(@api_key)
   end
 
   def parse_email
-    @parse_instance ||= ParseEmail.new(@api_user, @api_key)
+    @parse_instance ||= ParseEmail.new(@api_key)
   end
 
   def limits
-    @limit_instance ||= Limit.new(@api_user, @api_key)
+    @limit_instance ||= Limit.new(@api_key)
   end
 
   def stats
-    @stats_instance ||= Stats.new(@api_user, @api_key)
+    @stats_instance ||= Stats.new(@api_key)
   end
   
   def ip_management
-    @ip_management_instance ||= IpManagement.new(@api_user, @api_key)
+    @ip_management_instance ||= IpManagement.new(@api_key)
   end
 
   def monitor_records
-    @monitor_record_instance ||= MonitorRecord.new(@api_user, @api_key)
+    @monitor_record_instance ||= MonitorRecord.new(@api_key)
   end
 
   def white_label
-    @white_label_instance ||= WhiteLabel.new(@api_user, @api_key)
+    @white_label_instance ||= WhiteLabel.new(@api_key)
   end
  
   def iframe
-    @iframe_instance ||= Iframe.new(@api_user, @api_key)
+    @iframe_instance ||= Iframe.new(@api_key)
   end
 
   def auth
-    @auth_instance ||= Auth.new(@api_user, @api_key)
+    @auth_instance ||= Auth.new(@api_key)
   end
 
   def apps
-    @app_instance ||= App.new(@api_user, @api_key)
+    @app_instance ||= App.new(@api_key)
   end
  
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module SendGridWebApi
-  VERSION = "0.0.2"
-end
+  VERSION = "0.1.2"
+end

data/lib/web_api/blocks.rb

@@ -9,5 +9,10 @@ module SendGridWebApi::Modules
       block_delete_url = "blocks.delete.json"
       query_api(block_delete_url, options)
     end
+
+    def count options = {}
+      block_count_url = "blocks.count.json"
+      query_api(block_count_url, options)
+    end
   end  
 end

data/lib/web_api/bounces.rb

@@ -9,5 +9,10 @@ module SendGridWebApi::Modules
       bounce_delete_url = "bounces.delete.json"
       query_api(bounce_delete_url, options)
     end
+
+    def count options = {}
+      bounces_count_url = "bounces.count.json"
+      query_api(bounces_count_url, options)
+    end
   end
 end

data/lib/web_api/modules.rb

@@ -5,46 +5,50 @@ end
 
 module SendGridWebApi::Modules
   def bounces
-    @bounce_instance ||= Bounce.new(@api_user, @api_key)
+    @bounce_instance ||= Bounce.new(@api_key)
   end
 
   def blocks
-    @block_instance ||= Block.new(@api_user, @api_key)
+    @block_instance ||= Block.new(@api_key)
   end
 
   def spam
-    @spam_instance ||= Spam.new(@api_user, @api_key)
+    @spam_instance ||= Spam.new(@api_key)
   end
 
   def invalid_emails
-    @invalid_email_instance ||= InvalidEmail.new(@api_user, @api_key)
+    @invalid_email_instance ||= InvalidEmail.new(@api_key)
   end
 
   def unsubscribes
-    @unsubscribe_instance ||= Unsubscribe.new(@api_user, @api_key)
+    @unsubscribe_instance ||= Unsubscribe.new(@api_key)
   end
 
   def parse_email
-    @parse_email_instance ||= ParseEmail.new(@api_user, @api_key)
+    @parse_email_instance ||= ParseEmail.new(@api_key)
   end
 
   def event_notification
-    @event_notification_instance ||= EventNotification.new(@api_user, @api_key)
+    @event_notification_instance ||= EventNotification.new(@api_key)
   end
 
   def stats
-    @stats_instance ||= Stats.new(@api_user, @api_key)
+    @stats_instance ||= Stats.new(@api_key)
   end
 
   def profile
-    @profile_instance ||= Profile.new(@api_user, @api_key)
+    @profile_instance ||= Profile.new(@api_key)
   end
 
   def mail
-    @mail_instance ||= Mail.new(@api_user, @api_key)
+    @mail_instance ||= Mail.new(@api_key)
   end
   
   def sub_user
-    @sub_user ||= SendGridWebApi::SubUser.new(@api_user, @api_key)
+    @sub_user ||= SendGridWebApi::SubUser.new(@api_key)
+  end
+
+  def apikey
+    @apikey ||= SendGridWebApi::ApiKey.new(@api_key)
   end
 end

data/lib/web_api/version.rb

@@ -1,3 +1,3 @@
 module SendGridWebApi
-  VERSION = "0.0.3"
+  VERSION = "0.0.6"
 end

data/lib/webapi_client.rb

@@ -5,7 +5,7 @@ module SendGridWebApi
     include SendGridWebApi::Modules
     
     def base_url
-      "https://sendgrid.com/api/"
+      "https://api.sendgrid.com/api/"
     end
     
   end

data/sendgrid_webapi.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require 'version'
+require "version"
 
 Gem::Specification.new do |s|
   s.name        = "sendgrid_webapi"
@@ -8,9 +8,10 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["kylejginavan", "chebyte"]
   s.email       = ["kylejginavan@gmail.com", "maurotorres@gmail.com"]
-  s.homepage    = "https://github.com/kylejginavan/sendgrid_smtpapi"
+  s.homepage    = "https://github.com/kylejginavan/sendgrid_webapi"
   s.summary     = %q{SendGrid WEB API gem fo Rails}
   s.description = %q{Gem for access to SendGrid WEB API from rails}
+  s.license     = "MIT"
 
   s.rubyforge_project = "sendgrid_webapi"
 
@@ -18,10 +19,13 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.add_development_dependency "rspec", "~> 2.10.0"
-  s.add_development_dependency "webmock", "~> 1.8.7"
-  s.add_development_dependency "vcr", "~> 2.1.1"  
-  s.add_dependency "faraday", "~> 0.8.0"
-  s.add_dependency "json", "~> 1.8.0"
-  
+
+  s.add_dependency "faraday",          "~> 1.0"
+  s.add_dependency "faraday_middleware",  "~> 1.0"
+  s.add_dependency "json", "~> 2.0"
+
+  s.add_development_dependency "rspec", "~> 3.4"
+  s.add_development_dependency "webmock", "~> 3.12"
+  s.add_development_dependency "vcr", "~> 6.0"
+  s.add_development_dependency "rspec_junit_formatter",   "~> 0.3", ">= 0.3.0"
 end

data/spec/cassettes/client/_modules/_block/should_get_block_emails.yml

@@ -1,48 +1,36 @@
---- 
-http_interactions: 
-- request: 
+---
+http_interactions:
+- request:
     method: get
-    uri: https://sendgrid.com/api/blocks.get.json?api_key=pass&api_user=user
-    body: 
+    uri: https://api.sendgrid.com/api/blocks.get.json
+    body:
       encoding: US-ASCII
-      string: ""
-    headers: 
-      Accept-Encoding: 
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept: 
-      - "*/*"
-      User-Agent: 
-      - Ruby
-  response: 
-    status: 
+      Accept:
+      - '*/*'
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      Server: 
-      - nginx/0.7.65
-      Date: 
-      - Mon, 02 Jul 2012 14:42:51 GMT
-      Content-Type: 
-      - application/json
-      Connection: 
+    headers:
+      Server:
+      - nginx/1.4.2
+      Date:
+      - Fri, 17 Jan 2014 01:37:37 GMT
+      Content-Type:
+      - text/html
+      Transfer-Encoding:
+      - chunked
+      Connection:
       - keep-alive
-      X-Powered-By: 
-      - PHP/5.3.2-1ubuntu4.14
-      Cache-Control: 
-      - private
-      Set-Cookie: 
-      - sendgrid_frontend=f0e7344786a2d782f7bab47e30ecf283:de5a5348f999469fb4a7e2216d67fa03459c9f52; expires=Wed, 01-Aug-2012 14:42:27 GMT; path=/; httponly
-      Content-Encoding: 
-      - gzip
-      Vary: 
-      - Accept-Encoding
-      Content-Length: 
-      - "28"
-    body: 
-      encoding: ASCII-8BIT
-      string: !binary |
-        H4sIAAAAAAAAA4qOBQAAAP//AwApu0wNAgAAAA==
-
+    body:
+      encoding: UTF-8
+      string: '[]'
     http_version: 
-  recorded_at: Mon, 02 Jul 2012 14:42:51 GMT
-recorded_with: VCR 2.1.1
+  recorded_at: Fri, 17 Jan 2014 01:37:37 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/client/_modules/_block/should_get_totals_blocks.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.sendgrid.com/api/blocks.count.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.2
+      Date:
+      - Fri, 17 Jan 2014 01:37:40 GMT
+      Content-Type:
+      - text/html
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"count": 0}'
+    http_version: 
+  recorded_at: Fri, 17 Jan 2014 01:37:40 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/client/_modules/_block/should_try_delete_not_existing_block_email.yml

@@ -1,49 +1,36 @@
---- 
-http_interactions: 
-- request: 
+---
+http_interactions:
+- request:
     method: get
-    uri: https://sendgrid.com/api/blocks.delete.json?api_key=pass&api_user=user&email=test@example.com
-    body: 
+    uri: https://api.sendgrid.com/api/blocks.delete.json?email=test@example.com
+    body:
       encoding: US-ASCII
-      string: ""
-    headers: 
-      Accept-Encoding: 
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept: 
-      - "*/*"
-      User-Agent: 
-      - Ruby
-  response: 
-    status: 
+      Accept:
+      - '*/*'
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      Server: 
-      - nginx/0.7.65
-      Date: 
-      - Mon, 02 Jul 2012 14:42:53 GMT
-      Content-Type: 
-      - application/json
-      Connection: 
+    headers:
+      Server:
+      - nginx/1.4.2
+      Date:
+      - Fri, 17 Jan 2014 01:37:38 GMT
+      Content-Type:
+      - text/html
+      Transfer-Encoding:
+      - chunked
+      Connection:
       - keep-alive
-      X-Powered-By: 
-      - PHP/5.3.2-1ubuntu4.14
-      Cache-Control: 
-      - private
-      Set-Cookie: 
-      - sendgrid_frontend=b1552d80418879e57ecce9ff13f7e16c:60b4e990d7fa4abbf759b653ee408ab726e8db97; expires=Wed, 01-Aug-2012 14:42:29 GMT; path=/; httponly
-      Content-Encoding: 
-      - gzip
-      Vary: 
-      - Accept-Encoding
-      Content-Length: 
-      - "60"
-    body: 
-      encoding: ASCII-8BIT
-      string: !binary |
-        H4sIAAAAAAAAA6pWyk0tLk5MT1WyUnLNTczMUUjJTy1WyMsvUUityCwuUaoF
-        AAAA//8DACrxmdciAAAA
-
+    body:
+      encoding: UTF-8
+      string: '{"message": "Email does not exist"}'
     http_version: 
-  recorded_at: Mon, 02 Jul 2012 14:42:53 GMT
-recorded_with: VCR 2.1.1
+  recorded_at: Fri, 17 Jan 2014 01:37:39 GMT
+recorded_with: VCR 2.8.0