minitel 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 648b98c8dc9f1b7ffb9dbfea6a2608dbf0e28e45
-  data.tar.gz: 73eb5fee51e79d898d0601ebff1b766231da210c
+  metadata.gz: 533325700a781993cff2caa0601121f48f6bc947
+  data.tar.gz: f28924e1b4dc9b948d60a5013d3fbe80dcf98f51
 SHA512:
-  metadata.gz: 7356837b3e88e75e92e087e474238983a46e810577ecad94eb4d5a6fceb98714e9c92e57a8965520ab058e8ea2fd46441cf37f2d1e10be32991c1499531217ce
-  data.tar.gz: a9b3532a374f148d609e8105bb1ee22fa715a83982f758b7053b53db266fa2acd66e8b1b05a20db2bc34b3e27ade1273b5f3ff97c5218ede3bb1d73957f42bca
+  metadata.gz: a4e7a4e76ca52053180758b98ddc370235d2741b100e948ce60df9ec68d83085c74818213dea25f411571b374d0154c9525dba1dc7f52b3949602bf57d99433a
+  data.tar.gz: e03e2a4e45de7a14e8f9afbf2c151e9e940831289246fb510be900cdf741355d9d66dd194a66f8e787143f313e9f067c44bc9c88194a6aa6c924e1266d066e4c

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -1,13 +1,14 @@
-bundler_args: --without development
 cache: bundler
 language: ruby
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.1.1
+  - 2.1.3
   - 2.1.2
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - ruby-head
 script: bundle exec rspec
 notifications:
     email: false

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     minitel (0.0.1)
-      excon (~> 0, > 0.16)
+      excon (~> 0, >= 0.16)
       multi_json (~> 1.0)
 
 GEM

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+end
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/Readme.md

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

data/changelog.txt

@@ -0,0 +1,9 @@
+0.1.0 2014-10-08
+================
+
+Bump minimum version of Excon to redact passwords on errors
+
+0.0.1 2014-10-04
+================
+
+initial release

data/lib/minitel.rb

@@ -1,5 +1,3 @@
-Minitel = Module.new
-
 require 'minitel/version'
 require 'minitel/client'
 

data/lib/minitel/client.rb

@@ -3,25 +3,58 @@ require 'excon'
 
 module Minitel
   class Client
-    attr_accessor :telex_url
+    attr_accessor :connection
 
     def initialize(telex_url)
-      raise "Bad Url" unless telex_url.start_with? "https://"
-      self.telex_url = telex_url
+      unless telex_url.start_with? "https://"
+        raise ArgumentError, "Bad Url"
+      end
+      self.connection = Excon.new(telex_url)
     end
 
     def notify_app(args)
+      keywords = [:app_uuid, :body, :title]
+      app_uuid, body, title = args[:app_uuid], args[:body], args[:title]
+
+      ensure_strict_args(args.keys, keywords)
+      ensure_no_nils(args, keywords)
+      ensure_is_uuid(app_uuid)
+
       message = {
-        title: args.fetch(:title),
-        body: args.fetch(:body),
-        target: {type: 'app', id: args.fetch(:app_uuid)}
+        title: title,
+        body: body,
+        target: {type: 'app', id: app_uuid}
       }
 
-      response = Excon.post("#{telex_url}/producer/messages",
+      response = connection.post(
+                   path: "/producer/messages",
                    body: MultiJson.dump(message),
                    expects: 201)
 
       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/version.rb

@@ -1,3 +1,3 @@
 module Minitel
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/minitel.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require_relative 'lib/minitel'
+require File.expand_path("../lib/minitel/version", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "minitel"
@@ -15,10 +14,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   gem.version       = Minitel::VERSION
-  gem.platform    = Gem::Platform::RUBY
+  gem.platform      = Gem::Platform::RUBY
   gem.license       = "MIT"
 
-  gem.add_runtime_dependency 'excon', '~> 0', "> 0.16"
+  gem.add_runtime_dependency 'excon', '~> 0', ">= 0.20"
   gem.add_runtime_dependency 'multi_json', '~> 1.0'
 
   gem.add_development_dependency 'rspec', '~> 3.0'

data/spec/minitel/client_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Minitel::Client, '#initialize' do
+  it 'requires an https url' do
+    expect{ Minitel::Client.new('http://user:pass@what.com')  }.to     raise_error(ArgumentError)
+    expect{ Minitel::Client.new('https://user:pass@what.com') }.to_not raise_error
+  end
+
+  it 'uses the given url and credentials' do
+    url = "https://u:p@foo.com"
+    mock = double(:excon)
+    expect(Excon).to receive(:new).with(url).and_return(mock)
+
+    client = Minitel::Client.new(url)
+
+    expect(client.connection).to eq(mock)
+  end
+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') }
+
+    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)
+    end
+
+    it 'posts a proper json body to the producer messages endpoint' do
+      expect{ client.notify_app(defaults) }.to_not raise_error
+
+      unstubbed_body = defaults.merge({title: 'bad title'})
+      expect{ client.notify_app(unstubbed_body) }.to raise_error(Excon::Errors::StubNotFound)
+    end
+
+    it 'returns a parsed json response' do
+      result = client.notify_app(defaults)
+      expect(result['success']).to eq(true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,13 @@
+require 'rubygems'
 require '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.0.1
+  version: 0.1.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-04 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -37,9 +37,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +47,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -85,15 +85,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
+- Rakefile
+- Readme.md
+- changelog.txt
 - lib/minitel.rb
 - lib/minitel/client.rb
 - lib/minitel/version.rb
 - minitel.gemspec
-- spec/minitel_spec.rb
+- spec/minitel/client_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/heroku/minitel
 licenses:
@@ -120,6 +125,6 @@ signing_key:
 specification_version: 4
 summary: "\U0001D54B\U0001D53C\U0001D543\U0001D53C\U0001D54F client: see https://github.com/heroku/telex"
 test_files:
-- spec/minitel_spec.rb
+- spec/minitel/client_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/minitel_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-
-describe Minitel do
-  it 'dummy test' do
-    expect(Minitel).to be_kind_of(Module)
-  end
-end