minitel 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61598e19639554992b7c083cac60ad2d778bdfda
-  data.tar.gz: 4acd579629f98f79f24533de0dbe40461c51dbe6
+  metadata.gz: fd03aab2f252c52edc3cfffe5d961c5c11969186
+  data.tar.gz: 5628686bc64d830a1624f63a798f90f9374b6349
 SHA512:
-  metadata.gz: 3d474d99a5d486cfbd0c4395bdd6f6c4ed0fd83abbe3d769c89adfe6acda17dd84c43c69211395084833be3e2c18a6bfd4cd0648635be3aad6aa5d5121dd6171
-  data.tar.gz: 82219867b18537333452e8011340fa6a5ba7e59809160c20ca1227b2300fcad938202864489febec9f3814836d72d57d743ed3238aa3749da2a26538f0acd659
+  metadata.gz: 22c953d027651ba60ae09c5ec203131885fdc1aaf9fa95b4bcf1959244f7b4111f988d75e4945a211d241050b65800da82b6cca3dbdaa40918e39e0a8d8113e3
+  data.tar.gz: 50e829ace42d49d3d2225900c23d7a13e21adbfc74bf8b546f9a92d96b79bfb8adf4040740706cfd85b7d87f773bc4fd3faf3058a56d9eacf050a52367e4a04e

data/Readme.md

@@ -1,5 +1,6 @@
 # 𝕄𝕀ℕ𝕀𝕋𝔼𝕃
 A 𝕋𝔼𝕃𝔼𝕏 client
 
+[![Gem Version](https://badge.fury.io/rb/minitel.svg)](http://badge.fury.io/rb/minitel)
 [![Build Status](https://travis-ci.org/heroku/minitel.svg?branch=master)](https://travis-ci.org/heroku/minitel)
 

data/changelog.txt

@@ -1,3 +1,8 @@
+0.2.0 2014-10-10
+================
+
+Add Client#notify_user for sending notifications to a single user
+
 0.1.1 2014-10-08
 ================
 

data/lib/minitel/client.rb

@@ -17,17 +17,22 @@ module Minitel
     end
 
     def notify_app(args)
-      keywords = [:app_uuid, :body, :title]
-      app_uuid, body, title = args[:app_uuid], args[:body], args[:title]
+      StrictArgs.enforce(args, [:app_uuid, :body, :title], :app_uuid)
+      post_message('app', args[:app_uuid], args[:title], args[:body])
+    end
+
+    def notify_user(args)
+      StrictArgs.enforce(args, [:user_uuid, :body, :title], :user_uuid)
+      post_message('user', args[:user_uuid], args[:title], args[:body])
+    end
 
-      ensure_strict_args(args.keys, keywords)
-      ensure_no_nils(args, keywords)
-      ensure_is_uuid(app_uuid)
+    private
 
+    def post_message(type, id, title, body)
       message = {
         title: title,
         body: body,
-        target: {type: 'app', id: app_uuid}
+        target: {type: type, id: id}
       }
 
       response = connection.post(
@@ -37,28 +42,5 @@ module Minitel
 
       MultiJson.load(response.body)
     end
-
-    private
-
-    # 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(', ')}"
-      end
-    end
-
-    def ensure_no_nils(args, keys)
-      keys.each do |key|
-       raise ArgumentError, "keyword #{key} is nil" unless args[key]
-      end
-    end
-
-    def ensure_is_uuid(uuid)
-      unless uuid =~ /\A[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}\z/i
-        raise ArgumentError, "not formated like a uuid"
-      end
-    end
-
   end
 end

data/lib/minitel/strict_args.rb

@@ -0,0 +1,30 @@
+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])
+    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(', ')}"
+      end
+    end
+
+    def ensure_no_nils(args, keys)
+      keys.each do |key|
+       raise ArgumentError, "keyword #{key} is nil" unless args[key]
+      end
+    end
+
+    def ensure_is_uuid(uuid)
+      unless uuid =~ /\A[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}\z/i
+        raise ArgumentError, "'#{uuid.inspect}' not formated like a uuid"
+      end
+    end
+  end
+end

data/lib/minitel/version.rb

@@ -1,3 +1,3 @@
 module Minitel
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/minitel.rb

@@ -1,3 +1,4 @@
 require 'minitel/version'
 require 'minitel/client'
+require 'minitel/strict_args'
 

data/spec/minitel/client_spec.rb

@@ -28,41 +28,6 @@ describe Minitel::Client, '#initialize' do
 end
 
 describe Minitel::Client, '#notify_app' do
-  describe 'arguments' do
-    let(:defaults) { {title: 'a title', body: 'a body', app_uuid: SecureRandom.uuid} }
-    let(:client)   { Minitel::Client.new('https://u:p@h.com') }
-
-    before do
-      Excon.stub({}, body: MultiJson.dump({}), status: 201)
-    end
-
-    it 'works when all 3 are present' do
-      expect { client.notify_app(defaults) }.to_not raise_error
-    end
-
-    [:title, :body, :app_uuid].each do |key|
-      it "fails when #{key} is missing from the arg hash" do
-        defaults.delete(key)
-        expect { client.notify_app(defaults) }.to raise_error(ArgumentError)
-      end
-
-      it "fails when #{key} is nil" do
-        defaults[key] = nil
-        expect { client.notify_app(defaults) }.to raise_error(ArgumentError)
-      end
-    end
-
-    it 'fails if app_uuid is not a uuid' do
-      defaults[:app_uuid] = "not a uuid"
-      expect { client.notify_app(defaults) }.to raise_error(ArgumentError)
-    end
-
-    it 'fails if there is an extra key' do
-      defaults.merge!( {foo: 3} )
-      expect { client.notify_app(defaults) }.to raise_error(ArgumentError)
-    end
-  end
-
   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') }
@@ -92,3 +57,33 @@ describe Minitel::Client, '#notify_app' do
     end
   end
 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') }
+
+  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)
+  end
+
+  it 'posts a proper json body to the producer messages endpoint' do
+    expect{ client.notify_user(defaults) }.to_not raise_error
+
+    unstubbed_body = defaults.merge({title: 'bad title'})
+    expect{ client.notify_user(unstubbed_body) }.to raise_error(Excon::Errors::StubNotFound)
+  end
+
+  it 'returns a parsed json response' do
+    result = client.notify_user(defaults)
+    expect(result['success']).to eq(true)
+  end
+end

data/spec/minitel/strict_args_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Minitel::StrictArgs, '.enforce' do
+  describe 'arguments' do
+    before do
+      @hash = {one: 1, two: 2, uuid: SecureRandom.uuid}
+      @keys = @hash.keys
+    end
+
+    it 'works when all listed args are present' do
+      expect { Minitel::StrictArgs.enforce(@hash, @keys, :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)
+    end
+
+    it "fails when a key is nil" do
+      @hash[:one] = nil
+      expect { Minitel::StrictArgs.enforce(@hash, @keys, :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)
+    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)
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.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-08 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -95,9 +95,11 @@ files:
 - changelog.txt
 - lib/minitel.rb
 - lib/minitel/client.rb
+- lib/minitel/strict_args.rb
 - lib/minitel/version.rb
 - minitel.gemspec
 - spec/minitel/client_spec.rb
+- spec/minitel/strict_args_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/heroku/minitel
 licenses:
@@ -125,5 +127,6 @@ specification_version: 4
 summary: "\U0001D54B\U0001D53C\U0001D543\U0001D53C\U0001D54F client: see https://github.com/heroku/telex"
 test_files:
 - spec/minitel/client_spec.rb
+- spec/minitel/strict_args_spec.rb
 - spec/spec_helper.rb
 has_rdoc: