pigeon-ruby 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 417ea3b3aa99576f3ee03f7c7eda300fbe11fb1ea9826862d60d2cf99b4faf73
-  data.tar.gz: 2e3c8a0c56b7eb1e10875915dc5bc1d25f00c04b1e545720475df016d052c81f
+SHA1:
+  metadata.gz: ab603586f5144bc39ea234f69d78340a81e37947
+  data.tar.gz: c6fbe3a2a0f33aba53024d5cdf12246d909db40f
 SHA512:
-  metadata.gz: 1f6ae48fb22ebf2753df62a5b6a0acbf0814f4e93807891044ecaec78834dcf035b74fc00072e4ca2b0d839aed271ba6c601775889c957b688b8d0bcd57440fc
-  data.tar.gz: 5648b6c7f0b5a12091ba6007efe83dbcbc8037e80e499893ff17dd8952d25f30a9be1c3074149e1e6781e968e6f1c14f09a6ca8ada4c8536ff0fca81fc207a60
+  metadata.gz: 67bdf87432736cd695d56666a4d9a2ef872115d7b6e93f2552906d0729699722fb4da9b21d5c9d66c6e273abc2af828fc9c89b3b1b998c5eb4ef7dd91551e9ec
+  data.tar.gz: 703a6edc1721c1441a85478efa569d1914b50e4f1821f8ce047f150501eec499dc80eaee55b0755fa56f838f7f2e6f3443ef150c8992a373833585517bbecdb6

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/README.md

@@ -18,10 +18,60 @@ Or install it yourself as:
 
     $ gem install pigeon
 
+
 ## Usage
 
+```ruby
+Pigeon.deliver('message-identifier', to: 'john@example.com')
 ```
-Pigeon.deliver('message-identifier', to: 'user@example.com')
+
+## Configuration
+
+```ruby
+Pigeon.configure do |config|
+  config.public_key = ENV['PIGEON_PUBLIC_KEY']
+  config.private_key = ENV['PIGEON_PRIVATE_KEY']
+end
+```
+
+To integrate Pigeon with your Rails application, create a new initializer `config/initializers/pigeon.rb`.
+
+## Examples
+
+### Multiple recipients
+
+```ruby
+Pigeon.deliver('message-identifier', {
+  to: 'John Doe <john@example.com>',
+  cc: ['admin@example.com', 'sales@example.com>']
+})
+```
+
+### Template variables
+
+Template variables are passed inside `:data`.
+
+```ruby
+Pigeon.deliver('message-identifier', {
+  to: 'john@example.com',
+  data: { name: 'John' }
+})
+```
+
+### Attachments support
+
+`:file` can be a local file path, remote URL, or a File object.
+
+```ruby
+Pigeon.deliver('message-identifier', {
+  to: 'jane@example.com',
+  attachments: [
+    {
+      file: '/path/to/handbook.pdf',
+      name: 'Handbook'
+    }
+  ]
+})
 ```
 
 ## Development
@@ -32,7 +82,20 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pigeon-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pigeonapp/pigeon-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Releasing
+
+We use the [gem-release](https://github.com/svenfuchs/gem-release) library for versioning, tagging and releasing.
+
+```
+gem bump
+gem release
+gem tag --push
+git push origin master
+```
+
+Use `gem bump -v [major|minor|patch|pre|release|x.x.x]` for specific version increases.
 
 ## License
 
@@ -40,4 +103,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Pigeon project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pigeon-ruby/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Pigeon project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pigeonapp/pigeon-ruby/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -1,14 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "pigeon"
+require 'bundler/setup'
+require 'pigeon-ruby'
+require 'irb'
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
 IRB.start(__FILE__)

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/lib/pigeon-ruby/client.rb

@@ -7,7 +7,7 @@ module Pigeon
     def initialize(config)
       @config = config
 
-      self.class.base_uri(@config.base_uri || 'https://api.pigeonapp.io')
+      self.class.base_uri(@config.base_uri || 'https://api.pigeonapp.io/v1')
     end
 
     def deliver(message_identifier, parcels = nil)
@@ -18,9 +18,31 @@ module Pigeon
         },
         body: {
           message_identifier: message_identifier,
-          parcels: parcels
+          parcels: process_parcels(parcels)
         }
       })
     end
+
+    private
+
+    def process_parcels(parcels)
+      parcels = [parcels] if parcels.is_a? Hash
+
+      parcels.each do |parcel|
+        (parcel[:attachments] || []).each do |attachment|
+          next unless File.file?(attachment[:file])
+
+          prepare_attachment_content(attachment)
+        end
+      end
+    end
+
+    def prepare_attachment_content(attachment)
+      file = attachment[:file]
+      file = File.open(file) if file.is_a? String
+      attachment[:content] = Base64.strict_encode64(file.read)
+      attachment[:name] ||= File.basename(file, '.*')
+      attachment.delete(:file)
+    end
   end
 end

data/lib/pigeon-ruby/version.rb

@@ -1,3 +1,3 @@
 module Pigeon
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pigeon-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Pradeep Kumar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-12 00:00:00.000000000 Z
+date: 2019-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Pigeon Ruby Library