pushover 1.0.4 → 2.0.0

data/lib/pushover/version.rb

@@ -1,4 +1,4 @@
 module Pushover
-	# The current version of Pushover.
-  VERSION = "1.0.4"
+  # The current version of Pushover.
+  VERSION = "2.0.0".freeze
 end

data/pushover.gemspec

@@ -1,33 +1,46 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/pushover/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.name          = "pushover"
-  gem.authors       = ["Ernie Brodeur"]
-  gem.email         = ["ebrodeur@ujami.net"]
-  gem.date          = Time.now.strftime('%Y-%m-%d')
-  gem.version       = Pushover::VERSION
-  gem.platform      = Gem::Platform::RUBY
-  gem.license       = "Beerware v42"
+require File.expand_path('lib/pushover/version', __dir__)
+Gem::Specification.new do |spec|
+  spec.name = 'pushover'
+  spec.authors       = ['Ernie Brodeur']
+  spec.email         = ['ebrodeur@ujami.net']
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.version       = Pushover::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.license       = 'MIT'
 
   # descriptions
-  gem.description   = "Api (and CLI) to interface with pushover.net"
-  gem.summary       = "This gem provides both an API and CLI interface to pushover.net."
-  gem.homepage      = "https://github.com/erniebrodeur/pushover"
+  spec.description   = 'Api (and CLI) to interface with pushover.net'
+  spec.summary       = 'This spec provides both an API and CLI interface to pushover.net.'
+  spec.homepage      = 'https://github.com/erniebrodeur/pushover'
 
-  #files
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  # files
+  spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
 
   # documentation
-  gem.extra_rdoc_files = Dir.glob("*.md")
-  gem.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Pushover", "--main", "README.md", "--encoding=UTF-8"]
-  gem.has_rdoc = 'yard'
+  spec.extra_rdoc_files = Dir.glob('*.md')
+  spec.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'Pushover', '--main', 'README.md', '--encoding=UTF-8']
+  spec.has_rdoc = 'yard'
 
   # dependencies.
-  gem.add_runtime_dependency 'yajl-ruby', "= 1.1.0"
-  gem.add_runtime_dependency 'httparty', "= 0.11.0"
-  gem.add_runtime_dependency 'bini', "= 0.7.0"
+  spec.add_runtime_dependency 'creatable'
+  spec.add_runtime_dependency 'excon'
+  spec.add_runtime_dependency 'oj'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
+  spec.add_development_dependency 'guard-yard'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-console'
+  spec.add_development_dependency 'yard'
 end

data/spec/lib/pushover/api_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+module Pushover
+  describe Api do
+    it { expect(described_class).to respond_to(:endpoints).with(0).argument }
+    it { expect(described_class).to respond_to(:connection).with(0).argument }
+    it { expect(described_class).to respond_to(:url).with(0).argument }
+    it { expect(described_class).to respond_to(:sounds).with(0).argument }
+    it { expect(described_class).to respond_to(:initialize).with(0).argument }
+
+    describe '::initialize' do
+      before { described_class.initialize }
+
+      it "is expected to set excon default Headers Content-Type to 'application/json'" do
+        expect(Excon.defaults[:headers]).to include('Content-Type' => 'application/json')
+      end
+
+      it "is expected to set excon default Headers User-Agent to 'pushover (ruby gem) v#{Pushover::VERSION}'" do
+        expect(Excon.defaults[:headers]).to include('User-Agent' => "pushover (ruby gem) v#{Pushover::VERSION}")
+      end
+    end
+
+    describe '::endpoints' do
+      it { expect(described_class.endpoints).to be_a_kind_of(Array) & include(a_kind_of(Symbol)) }
+    end
+
+    describe '::connection' do
+      it "is expected to return an excon connection" do
+        expect(described_class.connection).to be_a_kind_of Excon::Connection
+      end
+    end
+
+    describe '::sounds' do
+      it { expect(described_class.sounds).to be_a_kind_of(Array) & include(a_kind_of(Symbol)) }
+    end
+
+    describe '::url' do
+      it { expect(described_class.url).to eq 'https://api.pushover.net' }
+    end
+  end
+end

data/spec/lib/pushover/message_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+module Pushover
+  describe Message do
+    describe "Attributes" do
+      it { is_expected.to have_attributes(attachment: nil) }
+      it { is_expected.to have_attributes(device: nil) }
+      it { is_expected.to have_attributes(html: nil) }
+      it { is_expected.to have_attributes(message: nil) }
+      it { is_expected.to have_attributes(priority: nil) }
+      it { is_expected.to have_attributes(response: nil) }
+      it { is_expected.to have_attributes(sound: nil) }
+      it { is_expected.to have_attributes(timestamp: a_kind_of(Numeric)) }
+      it { is_expected.to have_attributes(title: nil) }
+      it { is_expected.to have_attributes(token: nil) }
+      it { is_expected.to have_attributes(url_title: nil) }
+      it { is_expected.to have_attributes(url: nil) }
+      it { is_expected.to have_attributes(user: nil) }
+    end
+
+    it { expect(described_class).to be_a_kind_of(Class) }
+    it { is_expected.to be_a_kind_of Creatable }
+
+    describe "Instance Signatures" do
+      it { is_expected.to respond_to(:push).with(0).argument }
+    end
+
+    describe "::push" do
+      let(:body) { { "status": 1, "request": "647d2300-702c-4b38-8b2f-d56326ae460b" } }
+      let(:excon_connection) { Excon.new Api.url }
+      let(:excon_response) { Excon::Response.new(body: Oj.dump(body), status: 200) }
+      let(:params) { { user: '1234', token: '1234', message: 'abcd' } }
+      let(:request) { Request.create }
+      let(:response) { Response.create original: excon_response }
+      let(:working_message) { described_class.create params }
+
+      before do
+        allow(Api).to receive(:connection).and_return excon_connection
+        allow(excon_connection).to receive(:post).and_return excon_response
+        allow(Response).to receive(:create).and_return response
+      end
+
+      shared_examples 'required_param' do |param|
+        context "when #{param} is not set" do
+          before { working_message.instance_variable_set "@#{param}".to_sym, nil }
+
+          it { expect { working_message.push }.to raise_error ArgumentError, /#{param} is a required parameter/ }
+        end
+      end
+
+      shared_examples 'extra_param' do |param|
+        context "when a #{param} is provided" do
+          before { working_message.instance_variable_set "@#{param}".to_sym, 'not_nil' }
+
+          it "is expected to add the #{param} to the query" do
+            working_message.push
+            expect(excon_connection).to have_received(:post).with(query: a_hash_including(param.to_s => 'not_nil'), path: '1/messages.json')
+          end
+        end
+      end
+
+      %i[message token user].each do |param|
+        include_examples 'required_param', param
+      end
+
+      %i[attachment device html priority sound title url_title url].each do |param|
+        include_examples 'extra_param', param
+      end
+
+      it "is expected to call Request.create with ..." do
+        allow(Request).to receive(:create).and_return(request)
+        working_message.push
+        expect(Request).to have_received(:create).with(no_args)
+      end
+
+      it "is expected to return response" do
+        expect(working_message.push).to eq response
+      end
+    end
+  end
+end

data/spec/lib/pushover/receipt_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+module Pushover
+  describe Receipt do
+  end
+end

data/spec/lib/pushover/request_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+module Pushover
+  describe Request do
+
+    let(:endpoint) { :messages }
+    let(:excon_connection) { Excon.new Api.url }
+    let(:params) { { user: '1234', token: '1234', message: 'abcd' } }
+    let(:request) { described_class.create }
+    let(:excon_response) { Excon::Response.new(body: Oj.dump(body), status: 200, headers: headers) }
+    let(:body) { { "status" => 1, "request" => "647d2300-702c-4b38-8b2f-d56326ae460b" } }
+    let(:request) { Request.new }
+    let(:response) { Response.create original: excon_response }
+    let(:headers) do
+      {
+        "X-Limit-App-Limit":     7500,
+        "X-Limit-App-Remaining": 7496,
+        "X-Limit-App-Reset":     1_393_653_600
+      }
+    end
+
+    it { expect(described_class).to be_a_kind_of(Class) }
+    it { is_expected.to be_a_kind_of Creatable }
+
+    describe "Instance Signatures" do
+      it { is_expected.to respond_to(:push).with(2).argument }
+    end
+
+    describe "::push" do
+      before do
+        allow(Api).to receive(:connection).and_return excon_connection
+        allow(excon_connection).to receive(:post).and_return excon_response
+        allow(Response).to receive(:create).and_return response
+        allow(response).to receive(:process).and_call_original
+      end
+
+
+      let(:request) { described_class.new }
+
+      it 'is expected to call Api.connection.get with query set to the second argument' do
+        request.push endpoint, params
+        expect(excon_connection).to have_received(:post).with(query: a_kind_of(Hash), path: '1/messages.json')
+      end
+
+      it "is expected to call Response.create with the response set to original" do
+        request.push endpoint, params
+        expect(Response).to have_received(:create).with(original: a_kind_of(Excon::Response))
+      end
+
+      it "is expected to call response.process to populate the object" do
+        request.push endpoint, params
+        expect(response).to have_received(:process)
+      end
+
+      it "is expected to return request" do
+        expect(request.push endpoint, params).to eq response
+      end
+    end
+  end
+end

data/spec/lib/pushover/response_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+module Pushover
+  describe Response do
+    let(:body) { { "status" => 1, "request" => "647d2300-702c-4b38-8b2f-d56326ae460b" } }
+    let(:receipt_body) { { "status" => 1, "request" => "647d2300-702c-4b38-8b2f-d56326ae460b", "receipt" => 'abcdefg' } }
+    let(:error_body) { { "user" => "invalid", "errors" => ["user identifier is invalid"], "status" => 0, "request" => "5042853c-402d-4a18-abcb-168734a801de" } }
+    let(:headers) do
+      {
+        "X-Limit-App-Limit":     7500,
+        "X-Limit-App-Remaining": 7496,
+        "X-Limit-App-Reset":     1_393_653_600
+      }
+    end
+    let(:excon_response) { Excon::Response.new(body: Oj.dump(body), status: 200, headers: headers) }
+    let(:response) { described_class.create original: excon_response }
+
+    it { is_expected.to be_a_kind_of Creatable }
+
+    it { expect(described_class).to be_a_kind_of(Class) }
+
+    describe "Attributes" do
+      it { is_expected.to have_attributes(errors: []) }
+      it { is_expected.to have_attributes(limit: nil) }
+      it { is_expected.to have_attributes(original: nil) }
+      it { is_expected.to have_attributes(receipt: nil) }
+      it { is_expected.to have_attributes(remaining: nil) }
+      it { is_expected.to have_attributes(request: nil) }
+      it { is_expected.to have_attributes(reset: nil) }
+      it { is_expected.to have_attributes(status: a_kind_of(Numeric)) }
+    end
+
+    describe "Instance Signatures" do
+      it { is_expected.to respond_to(:process).with(0).argument }
+      it { is_expected.to respond_to(:process_body).with(0).argument }
+      it { is_expected.to respond_to(:process_headers).with(0).argument }
+    end
+
+    describe '::process' do
+      shared_examples 'process_verb' do |verb|
+        it "is expected to call process_#{verb}" do
+          allow(response).to receive("process_#{verb}".to_sym)
+          response.process
+          expect(response).to have_received("process_#{verb}".to_sym)
+        end
+      end
+
+      include_examples 'process_verb', 'body'
+      include_examples 'process_verb', 'headers'
+    end
+
+    describe '::process_body' do
+      context "when a receipt is provided" do
+        let(:body) { receipt_body }
+
+        it "is expected to set receipt" do
+          expect { response.process_body }.to change(response, :receipt).to body["receipt"]
+        end
+      end
+
+      context "when a errors is provided" do
+        let(:body) { error_body }
+
+        it "is expected to set errors" do
+          expect { response.process_body }.to change(response, :errors).to body["errors"]
+        end
+      end
+
+      it "is expected to call Oj.load" do
+        allow(Oj).to receive(:load).and_call_original
+        response.process_body
+        expect(Oj).to have_received(:load)
+      end
+
+      it "is expected to set status" do
+        expect { response.process_body }.to change(response, :status).to body["status"]
+      end
+
+      it "is expected to set request" do
+        expect { response.process_body }.to change(response, :request).to body["request"]
+      end
+    end
+
+    describe '::process_headers' do
+      it "is expected to set limit to X-Limit-App-Limit" do
+        expect { response.process_headers }.to change(response, :limit).to headers[:'X-Limit-App-Limit']
+      end
+
+      it "is expected to set remaing to X-Limit-App-Remaining" do
+        expect { response.process_headers }.to change(response, :remaining).to headers[:'X-Limit-App-Remaining']
+      end
+
+      it "is expected to set reset to X-Limit-App-Reset" do
+        expect { response.process_headers }.to change(response, :reset).to headers[:'X-Limit-App-Reset']
+      end
+    end
+  end
+end

data/spec/lib/pushover_spec.rb

@@ -1,119 +1,4 @@
 require 'spec_helper'
 
-describe "Pushover" do
-  before :all do
-    Bini.cache_dir = "tmp/cache_dir"
-    Bini.data_dir = "tmp/data_dir"
-    Bini.config_dir = "tmp/config_dir"
-  end
-  before :each do
-    App.current_app = nil
-    User.current_user = nil
-    Pushover.clear
-  end
-
-  describe "#clear" do
-    it "will erase all the attributes in Pushover" do
-      Pushover.send("#{keys.first}=", "something")
-      Pushover.clear
-      parameters.each {|k,v| v.should be_nil}
-    end
-  end
-
-  describe "#parameters?" do
-    it 'will return true only if every key is set to something.' do
-      keys.each do |k|
-        if k == :timestamp
-          Pushover.send("timestamp=", '1970-01-01 00:00:01 UTC')
-        else
-          Pushover.send("#{k}=", 'ladeda')
-        end
-      end
-      parameters?.should eq true
-    end
-    it 'will return false otherwise.' do
-      Pushover.send("#{keys.first}=", "something")
-      parameters?.should eq false
-    end
-  end
-
-  describe "#configure" do
-    Pushover.keys.each do |key|
-      it "#{key} can be configured via .configure" do
-        r = "acdfef"
-        Pushover.configure do |c|
-          c.instance_variable_set "@#{key}", r
-        end
-        Pushover.send(key).should eq r
-      end
-    end
-  end
-
-  describe "#notification" do
-    it "can send a notification" do
-      setup_webmocks
-      Pushover.notification message:'a message', token:'good_token', user:'good_user'
-      WebMock.should have_requested(:post, /.*api.pushover.net.*/).with do |req|
-        puts req.body hash_including(priority:'ajkasdfj')
-      end
-    end
-
-    it "can send a notification with preconfigured user and token" do
-      setup_webmocks
-      Pushover.configure do |c|
-        c.user = 'good_user'
-        c.token = 'good_token'
-      end
-      Pushover.notification message:'a message'
-      WebMock.should have_requested(:post, /.*api.pushover.net.*/).with do |req|
-        puts req.body hash_including(priority:'ajkasdfj')
-      end
-    end
-  end
-
-  describe "extra behavior" do
-    describe "Priority" do
-      it "can be set by text" do
-        setup_webmocks
-        Pushover.notification message:'a message', token:'good_token', user:'good_user', priority:'low'
-        WebMock.should have_requested(:post, /.*api.pushover.net.*/).with { |req| req.body.include? 'priority=-1'}
-        setup_webmocks
-        Pushover.notification message:'a message', token:'good_token', user:'good_user', priority:'high'
-        WebMock.should have_requested(:post, /.*api.pushover.net.*/).with { |req| req.body.include? 'priority=1'}
-      end
-      it "falls back to normal" do
-        setup_webmocks
-        Pushover.notification message:'a message', token:'good_token', user:'good_user', priority:'kwkru'
-        WebMock.should have_requested(:post, /api.pushover.net/).with { |req| req.body.include? 'priority=0' }
-      end
-    end
-
-    describe "Time" do
-      it "can be set by epoch" do
-        setup_webmocks
-        Pushover.notification message:'a message', token:'good_token', user:'good_user', timestamp:1000
-        Pushover.notification message:'a message', token:'good_token', user:'good_user', timestamp:'1000'
-        WebMock.should have_requested(:post, /api.pushover.net/).with { |req| req.body.include? 'timestamp=1000' }.twice
-      end
-
-      it "can be set by a text string" do
-        setup_webmocks
-        Pushover.notification message:'a message', token:'good_token', user:'good_user', timestamp:'1970-01-01 00:00:01 UTC'
-        WebMock.should have_requested(:post, /api.pushover.net/).with { |req| req.body.include? 'timestamp=1' }
-      end
-    end
-
-    describe "Sounds" do
-      it "will cache the sounds locally for at least a day" do
-        setup_webmocks
-        cache_file = "#{Bini.cache_dir}/sounds.json"
-        FileUtils.rm(cache_file) if File.exist?(cache_file)
-        Pushover.sounds.keys.should include("pushover")
-        stat = File.stat(cache_file)
-        Pushover.sounds.keys.should include("none")
-        stat.mtime.to_i.should eq File.stat(cache_file).mtime.to_i
-      end
-    end
-
-  end
+describe Pushover do
 end