sendgrid-object 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e19a523dcdbc5c6efe82406745c1b994ee713ca154f51da85e324c3d22201db1
-  data.tar.gz: 14ac6f2d33bc077f99e389e81555d80655cbcedb5240528982ad317f9c0be819
+  metadata.gz: 6c49bb55dea48672ad89c27f53d16e1e5c4bc9c3cb2dee6aba924b5f847061e9
+  data.tar.gz: 1a22c127f140b2e915ebc2cd0aee804d2d3188c5c16c42475a34c2356bebaa51
 SHA512:
-  metadata.gz: a0e2c5ed76f84a0b5433d4863a9266af68275536bf311b069543a34de9734e225421ca2b87185b79a17defac6b07a9cab8b9091898767f6eeb9d8346c49ecc70
-  data.tar.gz: a1f740f02b68a1b6444e132e06c54b4a1f4b7ab72f7bab372ec67f494debf953a0973ac571e04d5ddd61209f4d17e1aef345e8330948ea0fc08c6e7f8e43cb8b
+  metadata.gz: bf4638be880b1cd939a2fd27030eebaaabadf6aeaa0f73074042f987014c93883145f9fccf385fadebcd2780e948c2239c62cbd76a8742b1b4f90fe2bf67764e
+  data.tar.gz: f6b280e2da12b426347df8875b95cc0f6722153cbff638ad17c3a43b37b73dec50abc0d66000df70711d77c2859127342f42a56a2a30756198c45d6e03da4ca2

data/README.md

@@ -6,16 +6,6 @@ This gem provide classes for an easy use of the [sendrig-ruby](https://github.co
 
 Ruby version >= 2.4 (except version [2.6.0](https://github.com/sendgrid/sendgrid-ruby/blob/main/TROUBLESHOOTING.md#ruby-versions))
 
-## Setup Environment Variables
-
-Update the development environment with your SENDGRID_API_KEY, for example:
-
-```
-echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
-echo "sendgrid.env" >> .gitignore
-source ./sendgrid.env
-```
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,11 +22,23 @@ Or install it yourself as:
 
     $ gem install sendgrid-object
 
+## Configuration
+
+You need to configure the api key with the following code. You can add it in `/config/initializers/sendgrid.rb` for example.
+
+```ruby
+require 'sendgrid-object'
+
+Sendgrid.config do
+  api_key    'YOUR_API_KEY_HERE'
+end
+```
+
 ## Quick start
 
 ### Find a recipient
 
-```
+```ruby
 recipient = Sendgrid::Recipient.new()
 recipient.find_by("email", "john@doe.com")
 => {"id"=>"ID", "email"=>"john@doe.com", "created_at"=>TIMESTAMP, "updated_at"=>TIMESTAMP, "last_emailed"=>TIMESTAMP, "last_clicked"=>TIMESTAMP, "last_opened"=>TIMESTAMP, "first_name"=>"John", "last_name"=>"Doe"} 
@@ -50,7 +52,7 @@ end
 
 ### Create a recipient
 
-```
+```ruby
 recipient = Sendgrid::Recipient.new()
 recipient.create({ email: "jane@doe.com" })
 => "ID"
@@ -64,7 +66,7 @@ end
 
 ### Add a recipient to an existing list
 
-```
+```ruby
 recipient = Sendgrid::Recipient.new()
 recipient.find_by("email", "john@doe.com")
 list = Sendgrid::List.new()
@@ -77,7 +79,7 @@ end
 
 OR
 
-```
+```ruby
 recipient = Sendgrid::Recipient.new()
 recipient.find_by("email", "john@doe.com")
 list = Sendgrid::List.new()
@@ -90,7 +92,7 @@ puts "User successfully added." unless list.errors
 
 ### Destroy a recipient
 
-```
+```ruby
 recipient = Sendgrid::Recipient.new()
 recipient.find_by("email", "john@doe.com")
 => {"id"=>"ID", "email"=>"john@doe.com", "created_at"=>TIMESTAMP, "updated_at"=>TIMESTAMP, "last_emailed"=>TIMESTAMP, "last_clicked"=>TIMESTAMP, "last_opened"=>TIMESTAMP, "first_name"=>"John", "last_name"=>"Doe"} 
@@ -102,7 +104,7 @@ end
 
 OR
 
-```
+```ruby
 recipient = Sendgrid::Recipient.new()
 recipient.destroy("ID")
 puts "User successfully destroyed." unless recipient.errors
@@ -110,12 +112,8 @@ puts "User successfully destroyed." unless recipient.errors
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/immateriel/sendgrid-object. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sendgrid-object/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/immateriel/sendgrid-object. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/immateriel/sendgrid-object/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Sendgrid::Object project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sendgrid-object/blob/master/CODE_OF_CONDUCT.md).

data/lib/sendgrid/list.rb

@@ -3,7 +3,7 @@ class Sendgrid::List
   attr_accessor :name
 
   def initialize(data = {})
-    @api = ::SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+    @api = ::SendGrid::API.new(api_key: Sendgrid.api_key)
     @errors = nil
     reset_properties
     @name ||= data["name"]

data/lib/sendgrid/recipient.rb

@@ -3,7 +3,7 @@ class Sendgrid::Recipient
   attr_accessor :email, :first_name, :last_name
 
   def initialize
-    @api = ::SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])
+    @api = ::SendGrid::API.new(api_key: Sendgrid.api_key)
     @errors = nil
     reset_properties
   end

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module Sendgrid
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/sendgrid.rb

@@ -1,2 +1,22 @@
 module Sendgrid
+  extend self
+
+  def parameter(*names)
+    names.each do |name|
+      attr_accessor name
+
+      define_method name do |*values|
+        value = values.first
+        value ? self.send("#{name}=", value) : instance_variable_get("@#{name}")
+      end
+    end
+  end
+
+  def config(&block)
+    instance_eval &block
+  end
 end
+
+Sendgrid.config do
+  parameter :api_key
+end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require "bundler/setup"
 require "sendgrid-object"
 require 'webmock/rspec'
 
-ENV['SENDGRID_API_KEY']="ThisIsAFakeKey"
+Sendgrid.api_key = "ThisIsAFakeKey"
 
 RSpec.configure do |config|
 
@@ -12,14 +12,14 @@ RSpec.configure do |config|
     headers = {
       'Accept'=>'application/json',
       'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
-      'Authorization'=>"Bearer #{ENV['SENDGRID_API_KEY']}",
+      'Authorization'=>"Bearer #{Sendgrid.api_key}",
       'Content-Type'=>'application/json',
       'User-Agent'=>'sendgrid/6.6.1;ruby'
     }
     headers_without_content_type = {
       'Accept'=>'application/json',
       'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
-      'Authorization'=>"Bearer #{ENV['SENDGRID_API_KEY']}",
+      'Authorization'=>"Bearer #{Sendgrid.api_key}",
       'User-Agent'=>'sendgrid/6.6.1;ruby'
     }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-object
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Elodie Ailleaume
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sendgrid-ruby