sendgrid_webapi 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c318215ba8b2b1023891b605e2b47857d7af9ab5592b0f741fa9947b1815af45
-  data.tar.gz: b39d21419377d4808a0dcd3bddebf838d30f00534cc95fefa5850ac06ab13fc3
+  metadata.gz: 87c6ec1a7f2e80f0035f7d2684ddd206f28ced646c849d4a7e96625a92dd0028
+  data.tar.gz: 8f22f5a4195044a4d26658094a9c6b677a93471f61c96d96ab4f4fa474e95a8d
 SHA512:
-  metadata.gz: 969e60cd620a4397735a996e01050e07300083c09eaa0ac13f7f175262b62d09cf0c282ea28b6bb457ca8a24bb91d5616ef21a1f51f17438d2aa58c4a07696da
-  data.tar.gz: eac4a40143a43526a572289cedc047dd3813ca3aacd3760cc36437913110945f6222e9a74204d142a1a26a5ed3529084b35b96f7ea40ae457c3ce77a7fae6b94
+  metadata.gz: 38bc99e1615e4dd74977421d7a39ead0ec5524f7d95ec80436176058f4beb02afbd40ac9d13a635ba4e2f81c7239b0b529b657a8e444406cbab24f641d182104
+  data.tar.gz: 65e22460494c7c7d256df1d8beb06df64edee592b6099612ba305d43dc67a3ef28b76c90668470a7046151b35c33c413a715674b74f2808673536cd96fc08222

data/.circleci/setup-rubygems.sh

@@ -1,5 +1,5 @@
 #!/bin/sh
 
-mkdir ~/.gem
+mkdir -p ~/.gem
 echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
 chmod 0600 /home/circleci/.gem/credentials

data/.rspec

@@ -1,3 +1,2 @@
---format Fuubar
 --color
 --require spec_helper

data/README.rdoc

@@ -19,7 +19,7 @@ for sendgrid v2 support
 
 === Creating client object:
 
-    client = SendGridWebApi::Client.new("user_name", "password")
+    client = SendGridWebApi::Client.new("apikey")
 
 == Modules
 
@@ -131,7 +131,7 @@ This module allows you to send email.
 
 === Creating client object:
 
-    client = SendGridWebApi::Client.new("user_name", "password")
+    client = SendGridWebApi::Client.new("apikey")
 
     client.sub_user
 
@@ -340,6 +340,31 @@ This module allows you to setup subusers app settings.
 * options are available here: http://sendgrid.com/docs/API_Reference/Customer_Subuser_API/apps.html
 
 
+=== Apikey
+This module allows you to manage apikeys
+
+    client.apikey.management.get
+
+    client.apikey.management.get({ on_behalf_of: "SUB_USERNAME" })
+
+    client.apikey.management.get({ apikey_id: "APIKEY_ID" })
+
+    client.apikey.management.get({ on_behalf_of: "SUB_USERNAME" })
+
+    client.apikey.management.create({ "name" => "APIKEY NAME", "scopes" => ["mail.send"] })
+
+    client.apikey.management.create({ on_behalf_of: "SUB_USERNAME", "name" => "APIKEY NAME", "scopes" => ["mail.send"] })
+
+    client.apikey.management.update("APIKEY_ID", { "name" => "NEW APIKEY NAME"})
+
+    client.apikey.management.update("APIKEY_ID", { on_behalf_of: "SUB_USERNAME", "name" => "NEW APIKEY NAME"})
+
+    client.apikey.management.delete("APIKEY_ID")
+
+    client.apikey.management.delete("APIKEY_ID", { on_behalf_of: "SUB_USERNAME" })
+
+* options are available here: https://sendgrid.com/docs/api-reference/
+
 == Helper
 
 === Create Sub User

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

@@ -2,10 +2,9 @@ require 'faraday_middleware'
 
 module SendGridWebApi
   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
 
@@ -14,17 +13,46 @@ module SendGridWebApi
     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)
@@ -32,7 +60,10 @@ module SendGridWebApi
     end
 
     def session
-      @connection ||= ::Faraday.new base_url do |conn|
+      @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

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.8"
+  VERSION = "0.1.0"
 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/spec/cassettes/client/_modules/_block/should_get_block_emails.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sendgrid.com/api/blocks.get.json?api_key=pass&api_user=user
+    uri: https://api.sendgrid.com/api/blocks.get.json
     body:
       encoding: US-ASCII
       string: ''

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

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sendgrid.com/api/blocks.count.json?api_key=pass&api_user=user
+    uri: https://api.sendgrid.com/api/blocks.count.json
     body:
       encoding: US-ASCII
       string: ''

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

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sendgrid.com/api/blocks.delete.json?api_key=pass&api_user=user&email=test@example.com
+    uri: https://api.sendgrid.com/api/blocks.delete.json?email=test@example.com
     body:
       encoding: US-ASCII
       string: ''

data/spec/cassettes/client/_modules/_bounce/should_get_bounce_emails.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sendgrid.com/api/bounces.get.json?api_key=pass&api_user=user
+    uri: https://api.sendgrid.com/api/bounces.get.json
     body:
       encoding: US-ASCII
       string: ''