minitel 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65b9eb7da885c09645279a948daa4a61dfe74d7b
-  data.tar.gz: f9f45910ae96e042306d4d900ecb6a849802c3b3
+  metadata.gz: 1a746a71bce4fb28ed51a555f0669724e7bfd133
+  data.tar.gz: 2981f18e075b1d60d55cc82cf9ca46eb07e3c60b
 SHA512:
-  metadata.gz: 874a4d581a8c49727c1f54fd480d609d8af262c643eac4883c3ddeba794ec3188e3887614db1c54993b6ecd7658a37e0514a6fd1d672bd4b4a0aa3dfa3ab22b6
-  data.tar.gz: bc4f9e8a874b86b7ca4199267ce1eaaad762d3d5c172b61e55ba80bb12055887bfc309f21b2bfbc313bddeac1458b00403625dd4be4ba9a76672053ad246cba4
+  metadata.gz: 056e50f9fe5f3793f9eb9833051c6aa9a50f9cfe10e8effb6ff07da42410513e6fecc4ec01928595c0307c128f64ae592338a793c54a5e5e98e95e93137572c2
+  data.tar.gz: b9b491b75dee0c22f75d96ebc5d808bd4716b3aefc332d73440378f07a371603c8ab2ed8defa2a958d1a2a2b937b83828810357b6d081143ca709b03835d91d4

checksums.yaml.gz.sig

@@ -1,2 +1 @@
-D�(���D}T�N}w�B'.Cb��i��U��_�K���6��a[/7��ؽK�G��=�f�9����:`�7��
-'�g�k���]�L<�Y��vR��ӵ��=Q"?�s�E�;���:^�Q��o�)��#ͣ���
�hޏ#;���g&sy��_��<�us�Y�3�VX(o*�g�8Q�� Ao5�p�cNGkGK��t)�[�׊��}ȃ=�T�j��e.�L�\�FZ?Lh��8m��|�����Z\BTWr�
+��C“�Q��AfV<3��!(����8�1/�'_�ag͒�HQ�]�Y�~��Ӝ�]��c��с��p�C�;��|\�k���Y�����E��Xӊ�U:S�&iJa�R�(>��#+:�)�k�\��5&q+�i�B��Q~��
jΎ�.�
 �O�ֿK]���͕3|����V���tOcۧ����J��GiiY����	�\�%�=���/��mM*H��r�8b'q5mbS��|�\�@?v

data/.rspec

@@ -0,0 +1,2 @@
+--color
+

data/.travis.yml

@@ -1,14 +1,13 @@
 cache: bundler
 language: ruby
 rvm:
-  - 2.1.3
-  - 2.1.2
-  - 2.1.1
-  - 2.1.0
+  - 2.2.0
+  - 2.1.5
   - 2.0.0
   - 1.9.3
   - ruby-head
 script: bundle exec rspec
 notifications:
     email: false
+sudo: false
 

data/Readme.md

@@ -11,14 +11,21 @@ require 'minitel'
 # create a client
 client = Minitel::Client.new("https://user:pass@telex.heroku.com")
 
-# send a notifcation to the owner and collaborators of an app
-client.notify_app(app_uuid: '...', title: 'Something happened', body: 'here are the details')
+# send a notification to the owner and collaborators of an app
+client.notify_app(app_uuid: '...', title: 'Your database is on fire!', body: 'Sorry.')
 # => {"id"=>"uuid of message"}
 
-# send a notifcation to a user
-client.notify_user(user_uuid: '...', title: 'Something happened', body: 'here are the details')
+# send a notification to a user
+client.notify_user(user_uuid: '...', title: 'Here is your invoice', body: 'You owe us 65k.')
 # => {"id"=>"uuid of message"}
 
-# add folloup to a previous notificaiton
-client.notify_user(message_uuid: '...', body: 'here are even more details')
+# send a notification with an email action
+# see: https://developers.google.com/gmail/markup/reference/go-to-action
+client.notify_user(user_uuid: '...',
+  title: 'Here is your invoice',
+  body: 'You owe us 65k.',
+  action: { label: 'View Invoice', url: 'https://heroku.com/invoices/12345-12-98765'})
+
+# add folloup to a previous notification
+client.add_followup(message_uuid: '...', body: 'here are even more details')
 ```

data/lib/minitel/client.rb

@@ -17,31 +17,40 @@ module Minitel
     end
 
     def notify_app(args)
-      StrictArgs.enforce(args, [:app_uuid, :body, :title], :app_uuid)
-      post_message('app', args[:app_uuid], args[:title], args[:body])
+      StrictArgs.enforce(args, [:app_uuid, :body, :title], [:action], :app_uuid)
+      if action = args[:action]
+        StrictArgs.enforce(action, [:label, :url])
+      end
+      post_message('app', args[:app_uuid], args[:title], args[:body], action)
     end
 
     def notify_user(args)
-      StrictArgs.enforce(args, [:user_uuid, :body, :title], :user_uuid)
-      post_message('user', args[:user_uuid], args[:title], args[:body])
+      StrictArgs.enforce(args, [:user_uuid, :body, :title], [:action], :user_uuid)
+      if action = args[:action]
+        StrictArgs.enforce(action, [:label, :url])
+      end
+      post_message('user', args[:user_uuid], args[:title], args[:body], action)
     end
 
     def add_followup(args)
-      StrictArgs.enforce(args, [:message_uuid, :body], :message_uuid)
+      StrictArgs.enforce(args, [:message_uuid, :body], [], :message_uuid)
       followup = { body: args[:body] }
-
       post("/producer/messages/#{args[:message_uuid]}/followups", followup)
     end
 
     private
 
-    def post_message(type, id, title, body)
+    def post_message(type, id, title, body, action)
       message = {
         title: title,
         body: body,
         target: {type: type, id: id}
       }
 
+      if action
+        message.merge!(action: action)
+      end
+
       post("/producer/messages", message)
     end
 

data/lib/minitel/strict_args.rb

@@ -1,17 +1,21 @@
 module Minitel
   module StrictArgs
     extend self
-    def enforce(args, keywords, uuid_field)
-      ensure_strict_args(args.keys, keywords)
-      ensure_no_nils(args, keywords)
-      ensure_is_uuid(args[uuid_field])
+    def enforce(args, required, allowed=[], uuid_field=nil)
+      ensure_strict_args(args.keys, required, allowed)
+      ensure_no_nils(args, required)
+      ensure_is_uuid(args[uuid_field]) if uuid_field
     end
 
     # A Ruby 2.1 required keyword argument sorta backport
-    def ensure_strict_args(keys, accept_keys)
-      if keys.sort != accept_keys.sort
-        delta = accept_keys - keys
-        raise ArgumentError, "missing or extra keywords: #{delta.join(', ')}"
+    def ensure_strict_args(keys, required, allowed)
+      missing = required - keys
+      unless missing.empty?
+        raise ArgumentError, "missing keywords: #{missing.join(', ')}"
+      end
+      unknown = keys - (required + allowed)
+      unless unknown.empty?
+        raise ArgumentError, "extra keywords: #{unknown.join(', ')}"
       end
     end
 

data/lib/minitel/version.rb

@@ -1,3 +1,3 @@
 module Minitel
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/minitel.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'guard', '~> 2.6'
   gem.add_development_dependency 'guard-rspec', '~> 4.3'
   gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'webmock', '~> 1.20'
 end

data/spec/minitel/client_spec.rb

@@ -30,25 +30,30 @@ end
 describe Minitel::Client, '#notify_app' do
   describe 'action' do
     let(:defaults) { {title: 'a title', body: 'a body', app_uuid: SecureRandom.uuid} }
-    let(:client)   { Minitel::Client.new('https://u:p@h.com') }
+    let(:client)   { Minitel::Client.new('https://telex.com') }
 
     before do
-      request = {path: '/producer/messages', method: :post}
-      response = {status: 201, body: MultiJson.dump({'success' => true})}
-      body = MultiJson.dump({
-        title: 'a title',
-        body: 'a body',
-        target: {type: 'app', id: defaults[:app_uuid]}
-      })
-
-      Excon.stub(request.merge(body: body), response)
+      @stub = stub_request(:post, 'https://telex.com/producer/messages').
+        to_return(status: 201, body: MultiJson.encode(success: true))
     end
 
     it 'posts a proper json body to the producer messages endpoint' do
-      expect{ client.notify_app(defaults) }.to_not raise_error
+      client.notify_app(defaults)
+      body = MultiJson.encode(
+        title: 'a title',
+        body: 'a body',
+        target: {type: 'app', id: defaults[:app_uuid]})
+      expect(@stub.with(body: body)).to have_been_requested
+    end
 
-      unstubbed_body = defaults.merge({title: 'bad title'})
-      expect{ client.notify_app(unstubbed_body) }.to raise_error(Excon::Errors::StubNotFound)
+    it 'supports actions' do
+      action = { label: 'omg', url: 'https://foo' }
+      client.notify_app(defaults.merge(action: action))
+      post_with_action = @stub.with do |req|
+        body = MultiJson.decode(req.body, symbolize_keys: true)
+        body[:action] == action
+      end
+      expect(post_with_action).to have_been_requested
     end
 
     it 'returns a parsed json response' do
@@ -61,25 +66,30 @@ end
 
 describe Minitel::Client, '#notify_user' do
   let(:defaults) { {title: 'a title', body: 'a body', user_uuid: SecureRandom.uuid} }
-  let(:client)   { Minitel::Client.new('https://u:p@h.com') }
+  let(:client)   { Minitel::Client.new('https://telex.com') }
 
   before do
-    request = {path: '/producer/messages', method: :post}
-    response = {status: 201, body: MultiJson.dump({'success' => true})}
-    body = MultiJson.dump({
-      title: 'a title',
-      body: 'a body',
-      target: {type: 'user', id: defaults[:user_uuid]}
-    })
-
-    Excon.stub(request.merge(body: body), response)
+    @stub = stub_request(:post, 'https://telex.com/producer/messages').
+      to_return(status: 201, body: MultiJson.encode(success: true))
   end
 
   it 'posts a proper json body to the producer messages endpoint' do
-    expect{ client.notify_user(defaults) }.to_not raise_error
+    client.notify_user(defaults)
+    body = MultiJson.encode(
+      title: 'a title',
+      body: 'a body',
+      target: {type: 'user', id: defaults[:user_uuid]})
+    expect(@stub.with(body: body)).to have_been_requested
+  end
 
-    unstubbed_body = defaults.merge({title: 'bad title'})
-    expect{ client.notify_user(unstubbed_body) }.to raise_error(Excon::Errors::StubNotFound)
+  it 'supports actions' do
+    action = { label: 'omg', url: 'https://foo' }
+    client.notify_user(defaults.merge(action: action))
+    post_with_action = @stub.with do |req|
+      body = MultiJson.decode(req.body, symbolize_keys: true)
+      body[:action] == action
+    end
+    expect(post_with_action).to have_been_requested
   end
 
   it 'returns a parsed json response' do
@@ -90,23 +100,17 @@ end
 
 describe Minitel::Client, '#add_followup' do
   let(:defaults) { {body: 'a body', message_uuid: SecureRandom.uuid} }
-  let(:client)   { Minitel::Client.new('https://u:p@h.com') }
+  let(:client)   { Minitel::Client.new('https://telex.com') }
 
   before do
-    request = {path: "/producer/messages/#{defaults[:message_uuid]}/followups", method: :post}
-    response = {status: 201, body: MultiJson.dump({'success' => true})}
-    body = MultiJson.dump({
-      body: 'a body',
-    })
-
-    Excon.stub(request.merge(body: body), response)
+    @stub = stub_request(:post, "https://telex.com/producer/messages/#{defaults[:message_uuid]}/followups").
+      to_return(status: 201, body: MultiJson.encode(success: true))
   end
 
   it 'posts a proper json body to the producer messages endpoint' do
-    expect{ client.add_followup(defaults) }.to_not raise_error
-
-    unstubbed_body = defaults.merge({message_uuid: SecureRandom.uuid})
-    expect{ client.add_followup(unstubbed_body) }.to raise_error(Excon::Errors::StubNotFound)
+    client.add_followup(defaults)
+    body = MultiJson.encode(body: 'a body')
+    expect(@stub.with(body: body)).to have_been_requested
   end
 
   it 'returns a parsed json response' do

data/spec/minitel/strict_args_spec.rb

@@ -4,31 +4,37 @@ describe Minitel::StrictArgs, '.enforce' do
   describe 'arguments' do
     before do
       @hash = {one: 1, two: 2, uuid: SecureRandom.uuid}
-      @keys = @hash.keys
+      @required = [:one, :uuid]
+      @optional = [:two]
     end
 
     it 'works when all listed args are present' do
-      expect { Minitel::StrictArgs.enforce(@hash, @keys, :uuid)  }.to_not raise_error
+      expect { Minitel::StrictArgs.enforce(@hash, @required, @optional, :uuid)  }.to_not raise_error
+    end
+
+    it 'works when optional args are omitted' do
+      @hash.delete(:two)
+      expect { Minitel::StrictArgs.enforce(@hash, @required, @optional, :uuid)  }.to_not raise_error
     end
 
     it "fails when a key is missing from the arg hash" do
       @hash.delete(:one)
-      expect { Minitel::StrictArgs.enforce(@hash, @keys, :uuid) }.to raise_error(ArgumentError)
+      expect { Minitel::StrictArgs.enforce(@hash, @required, @optional, :uuid) }.to raise_error(ArgumentError)
     end
 
     it "fails when a key is nil" do
       @hash[:one] = nil
-      expect { Minitel::StrictArgs.enforce(@hash, @keys, :uuid) }.to raise_error(ArgumentError)
+      expect { Minitel::StrictArgs.enforce(@hash, @required, @optional, :uuid) }.to raise_error(ArgumentError)
     end
 
     it 'fails if the uuid column uuid is not a uuid' do
       @hash[:uuid] = "not a uuid"
-      expect { Minitel::StrictArgs.enforce(@hash, @keys, :uuid) }.to raise_error(ArgumentError)
+      expect { Minitel::StrictArgs.enforce(@hash, @required, @optional, :uuid) }.to raise_error(ArgumentError)
     end
 
     it 'fails if there is an extra key' do
       @hash.merge!( {foo: 3} )
-      expect { Minitel::StrictArgs.enforce(@hash, @keys, :uuid) }.to raise_error(ArgumentError)
+      expect { Minitel::StrictArgs.enforce(@hash, @required, @optional, :uuid) }.to raise_error(ArgumentError)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,13 +1,7 @@
 require 'rubygems'
 require 'rspec'
+require 'webmock/rspec'
 require 'minitel'
 
 RSpec.configure do |config|
-  config.before(:all) do
-    Excon.defaults[:mock] = true
-  end
-
-  config.after(:each) do
-    Excon.stubs.clear
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitel
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Will Leinweber
@@ -28,7 +28,7 @@ cert_chain:
   5bkhRfJHSD/uX/cHbjmopLRbPlHrGbZTDIP4VEC5l0QLPiZ1nhKQnf3+U0+FSy2o
   CCngcLCR6q+mLf+A4L54VxmyrtFpcBfmkU72QYyf3vJ9QipL3XbvJvbpPkWSn1DX
   -----END CERTIFICATE-----
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2015-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -100,6 +100,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
 description: "\U0001D54B\U0001D53C\U0001D543\U0001D53C\U0001D54F client"
 email:
 - will@bitfission.com
@@ -108,6 +122,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -143,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: "\U0001D54B\U0001D53C\U0001D543\U0001D53C\U0001D54F client: see https://github.com/heroku/telex"