sendgrid_webapi 0.0.6 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2606be3393f22f3c3232828d711f981bc754048c
-  data.tar.gz: eaa623267e8d529e75c3978b4e5089ce3b6fd956
+SHA256:
+  metadata.gz: 2c4750102028a182ab7e513792ca0f127684c5ce2f59562dbe1997869c7099e9
+  data.tar.gz: 406420e68b953fca19e900acd80ab5914c689941588c4b056239f2f5f64f6971
 SHA512:
-  metadata.gz: 0fee7b15044d551cc1147857d545c12e26f76a73fd50d1b9c4a7221204ca8f0089b9280723c30317c39e3c1593d9dbf5e5b03c56f2a04c15cfad1eb742b3be2a
-  data.tar.gz: 5c3afaa1ef3fd6220be811a91cd3dd8bfca148faf8280c7e088552dfedcd6e31ba060e4caf1a25b38d95895dd8ec7400162787021581b13306b640f9535738fc
+  metadata.gz: d912c4463cb6cf6b77d55444e31302450e395c4b2c0eb14bbd4345b77d83dfbba7b3b5b9b563b0e0fff577a5989a00255c69d731d56c08495bd727eb3f15c358
+  data.tar.gz: 445d7ef45b7cb2b7325405120ef271ab1c6b13d50a902e83c63e5bebe16f95889c722f06555adedabb08ba4e70eb652eeec810a6a29f4d285dea64ec51def652

data/.circleci/config.yml

@@ -0,0 +1,132 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+defaults: &defaults
+  working_directory: ~/repo
+  docker:
+    - image: circleci/ruby:2.3.6-stretch-node
+      environment:
+        # - DBHOST: localhost
+        # - DBNAME: sendgrid_webapi_test
+        # - DBPASSWORD: Vdm9omJt8Z3MCV4N
+        # - DBUSER: test_user
+        - RACK_ENV: test
+        - RAILS_ENV: test
+    # - image: circleci/postgres:10.3-alpine-ram
+    #   environment:
+    #     - POSTGRES_DB: sendgrid_webapi_test
+    #     - POSTGRES_USER: test_user
+    #     - POSTGRES_PASSWORD: Vdm9omJt8Z3MCV4N
+
+version: 2
+jobs:
+  run_specs:
+    <<: *defaults
+
+    steps:
+      - run:
+          name: Set up environment
+          command: |
+            sudo apt-get update && sudo apt-get install -y apt-transport-https apt-utils
+
+      - checkout
+
+      - restore_cache:
+          keys:
+          - sendgrid_webapi-dependencies-v1-{{ checksum "sendgrid_webapi.gemspec" }}
+          - sendgrid_webapi-dependencies-v1-
+
+      - run:
+          name: Install dependencies
+          command: |
+            # curl -sS https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
+            # echo "deb http://apt.postgresql.org/pub/repos/apt/ stretch-pgdg main" | sudo tee /etc/apt/sources.list.d/pgdg.list
+            # sudo apt-get update && sudo apt-get install postgresql-client-10
+            bundle check --path=./vendor/bundle || bundle install --path=./vendor/bundle --jobs=4 --retry=3
+
+      - save_cache:
+          key: sendgrid_webapi-dependencies-v1-{{ checksum "sendgrid_webapi.gemspec" }}
+          paths:
+            - ./vendor/bundle
+
+      # - run:
+      #     name: Set up database
+      #     command: |
+      #       cp spec/internal/config/database.docker.yml spec/internal/config/database.yml
+
+      - run:
+          name: Run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+            bundle exec rspec --format progress --format RspecJunitFormatter --out /tmp/test-results/rspec.xml $TEST_FILES
+
+      - store_test_results:
+          path: /tmp/test-results
+
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+
+  build_gem:
+    <<: *defaults
+
+    steps:
+      - run:
+          name: Set up environment
+          command: |
+            sudo apt-get update && sudo apt-get install -y apt-transport-https apt-utils
+
+      - checkout
+
+      - restore_cache:
+          keys:
+          - sendgrid_webapi-dependencies-v1-{{ checksum "sendgrid_webapi.gemspec" }}
+          - sendgrid_webapi-dependencies-v1-
+
+      - run:
+          name: Install dependencies
+          command: |
+            gem install gemfury
+            bundle check --path=./vendor/bundle || bundle install --path=./vendor/bundle --jobs=4 --retry=3
+
+      - save_cache:
+          key: sendgrid_webapi-dependencies-v1-{{ checksum "sendgrid_webapi.gemspec" }}
+          paths:
+            - ./vendor/bundle
+
+      - run:
+          name: Build gem
+          command: |
+            gem build sendgrid_webapi.gemspec
+
+      - run:
+          name: Push gem
+          command: |
+            if [[ "${CIRCLE_PROJECT_USERNAME}" == "OneHQ" && "${CIRCLE_BRANCH}" == "master" && -n "${RUBYGEMS_API_KEY}" ]]; then
+              bash .circleci/setup-rubygems.sh
+              version=$(ruby -e 'load "lib/version.rb"; puts SendGridWebApi::VERSION')
+              grep -q "${version}" <(gem search sendgrid_api) || EXIT_CODE=$? && true
+              if [[ $EXIT_CODE == 1 ]]; then
+                gem push sendgrid_webapi-${version}.gem
+                git tag ${version}
+                git push --tags
+
+                [[ -n "$SLACK_TOKEN" ]] && curl -s -d "sendgrid_webapi ($version) released." "https://onehq.slack.com/services/hooks/slackbot?token=${SLACK_TOKEN}&channel=%23machines"
+              fi
+            fi
+
+workflows:
+  version: 2
+  build-deploy:
+    jobs:
+      - run_specs
+      - build_gem:
+          requires:
+            - run_specs
+          filters:
+            branches:
+              only:
+                - master
+                - staging

data/.circleci/setup-rubygems.sh

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

data/.gitignore

@@ -1,5 +1,31 @@
 *.gem
+*.pgz
+*.tmproj
 .bundle
+.DS_Store
+.gitconfig
+.idea
 .rvmrc
+.sass-cache
+/.ey_local_data
+/.ruby-gemset
+/.vagrant
+bin/*
+config/*.sphinx.conf
+config/database.yml
+config/sphinx.yml
+db/sphinx/
+Gemfile.lock
+log
+log/*.log
+project.rvmrc
+public/assets
+public/flash/*.swf
+public/javascripts/packaged/*.js
+public/packages/*
+public/stylesheets/packaged/*.css
+spec/internal/config/database.yml
+sphinx/**/*
+tmp
+tmp/**/*
 Gemfile.lock
-pkg/*

data/.rspec

@@ -1,2 +1,2 @@
---colour
---format nested
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.3.6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2021 Kyle Ginavan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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