pushover 2.0.0 → 3.0.0

data/lib/pushover/receipt.rb

@@ -1,5 +1,16 @@
 module Pushover
-  # Receipt class
-  class Receipt
+  # Receipt is a struct to interface with the receipt endpoint.
+  # @!attribute [rw] receipt
+  #   @return [String] id of the receipt to request
+  # @!attribute [rw] token
+  #   @return [String] application token to check for a receipt
+  Receipt = Struct.new(:receipt, :token, keyword_init: true) do
+    # Call pushover and return a response.
+    # @return [Response] response for the receipt request
+    def get
+      %i[receipt token].each { |param| raise "#{param} must be supplied" unless send param }
+
+      Response.create_from_excon_response Excon.get(path: "1/receipts/#{receipt}.json", query: { token: token })
+    end
   end
 end

data/lib/pushover/response.rb

@@ -1,40 +1,46 @@
 module Pushover
-  class Response
-    include Creatable
+  # Response encapsulates the response back from pushover.
+  # Class to wrap the user and basic functions related to it.
+  # @attribute status
+  #   @return [Numeric] status of the response
+  # @attribute request
+  #   @return [String] request is a UUID representing the specific call
+  # @attribute errors
+  #   @return [Array] errors includes any errors made
+  # @attribute receipt
+  #   @return [String] receipt returns a receipt if requested
+  # @attribute headers
+  #   @return [Hash] headers is the headers returned from the call.
+  # @attribute attributes
+  #   @return [String] any extra k/v pairs from the server.
+  Response = Struct.new(:status, :request, :errors, :receipt, :headers, :attributes, keyword_init: true) do
+    # New response object, from an excon_response
+    #   @return [Response] populated response object
+    def self.create_from_excon_response(excon_response)
+      json = Oj.load excon_response[:body]
+      values = {}
+      attributes = {}
+      json.each { |k, v| members.include?(k.to_sym) ? values.store(k, v) : attributes.store(k, v) }
 
-    attribute name: 'user', kind_of: String
-    attribute name: 'errors', kind_of: Array
-    attribute name: 'status', kind_of: Numeric
-    attribute name: 'receipt', kind_of: String
-    attribute name: 'request', kind_of: String
-    attribute name: 'original', kind_of: String
-    attribute name: 'limit', kind_of: String
-    attribute name: 'remaining', kind_of: String
-    attribute name: 'reset', kind_of: String
-
-    def initialize
-      @status = 0
-      @errors = []
+      Response.new values.merge(headers: excon_response.headers, attributes: attributes)
     end
 
-    def process
-      process_body
-      process_headers
+    # purty.
+    def to_s
+      "#{errors ? 'errors: ' + errors.join("\n") : 'status: ok'}, #{limits}"
     end
 
-    def process_body
-      body = Oj.load original[:body]
+    private
 
-      @status = body["status"]
-      @request = body["request"]
-      @receipt = body["receipt"] if body["receipt"]
-      @errors = body["errors"] if body["errors"]
-    end
+    # :nocov:
+    # Application limits
+    # @return [Array] 0: Remaining Calls, 1: Total Limit, 2: Limit Reset
+    def limits
+      return '' unless headers.include? 'X-Limit-App-Limit'
 
-    def process_headers
-      @limit = original.headers['X-Limit-App-Limit']
-      @remaining = original.headers['X-Limit-App-Remaining']
-      @reset = original.headers['X-Limit-App-Reset']
+      output = [headers['X-Limit-App-Remaining'], headers['X-Limit-App-Limit'], headers['X-Limit-App-Reset']]
+      output.define_singleton_method(:to_s) { "requests #{self[0]} of #{self[1]}, reset on #{Time.at(self[2].to_f)}" }
+      output
     end
   end
 end

data/lib/pushover/version.rb

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

data/pushover.gemspec

@@ -19,28 +19,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  # documentation
-  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.
-  spec.add_runtime_dependency 'creatable'
   spec.add_runtime_dependency 'excon'
+  spec.add_runtime_dependency 'gli'
   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_spec.rb

@@ -1,4 +1,7 @@
 require 'spec_helper'
 
 describe Pushover do
+  it "is expected to have a VERSION" do
+    expect(Pushover::VERSION).not_to be_nil
+  end
 end

data/spec/pushover/message_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Pushover::Message do
+  it { is_expected.to have_attributes(token: a_kind_of(String).or(be_nil)) }
+  it { is_expected.to have_attributes(user: a_kind_of(String).or(be_nil)) }
+  it { is_expected.to have_attributes(message: a_kind_of(String).or(be_nil)) }
+  it { is_expected.to have_attributes(attachment: a_kind_of(String).or(be_nil)) }
+  it { is_expected.to have_attributes(device: a_kind_of(String).or(be_nil)) }
+  it { is_expected.to have_attributes(title: a_kind_of(String).or(be_nil)) }
+  it { is_expected.to have_attributes(url: a_kind_of(String).or(be_nil)) }
+  it { is_expected.to have_attributes(url_title: a_kind_of(String).or(be_nil)) }
+  it { is_expected.to have_attributes(priority: a_kind_of(Numeric).or(be_nil)) }
+  it { is_expected.to have_attributes(sound: a_kind_of(String).or(be_nil)) }
+  it { is_expected.to have_attributes(timestamp: a_kind_of(DateTime).or(be_nil)) }
+  it { is_expected.to have_attributes(expire: a_kind_of(Numeric).or(be_nil)) }
+  it { is_expected.to have_attributes(retry: a_kind_of(Numeric).or(be_nil)) }
+  it { is_expected.to have_attributes(callback: a_kind_of(String).or(be_nil)) }
+
+  it { is_expected.to respond_to(:push).with(0).argument }
+
+  describe "#push" do
+    let(:params) { { 'token' => 't', 'user' => 'u', 'message' => 'message' } }
+
+    it "is expected to send" do
+      expect { described_class.new(params).push }.to raise_error Excon::Error::StubNotFound
+    end
+
+    ['token', 'user', 'message'].each do |param|
+      context "when #{param} is not supplied" do
+        before { params.delete param }
+
+        it { expect { described_class.new(params).push }.to raise_error RuntimeError, /#{param} must be supplied/ }
+      end
+    end
+  end
+end

data/spec/pushover/receipt_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Pushover::Receipt do
+  it { is_expected.to have_attributes(receipt: a_kind_of(String).or(be_nil)) }
+  it { is_expected.to have_attributes(token: a_kind_of(String).or(be_nil)) }
+
+  it { is_expected.to respond_to(:get).with(0).argument }
+
+  describe "#push" do
+    let(:params) { { 'token' => 't', 'receipt' => 'receipt' } }
+
+    it "is expected to send" do
+      expect { described_class.new(params).get }.to raise_error Excon::Error::StubNotFound
+    end
+
+    ['token', 'receipt'].each do |param|
+      context "when #{param} is not supplied" do
+        before { params.delete param }
+
+        it { expect { described_class.new(params).get }.to raise_error RuntimeError, /#{param} must be supplied/ }
+      end
+    end
+  end
+end

data/spec/pushover/response_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Pushover do
+  describe Pushover::Response do
+    let(:excon_response) { Excon::Response.new body: '{}', headers: {} }
+
+    it { is_expected.to have_attributes(status: a_kind_of(String).or(be_nil)) }
+    it { is_expected.to have_attributes(request: a_kind_of(String).or(be_nil)) }
+    it { is_expected.to have_attributes(errors: a_kind_of(Array).or(be_nil)) }
+    it { is_expected.to have_attributes(receipt: a_kind_of(String).or(be_nil)) }
+    it { is_expected.to have_attributes(headers: a_kind_of(Hash).or(be_nil)) }
+    it { is_expected.to have_attributes(attributes: a_kind_of(Hash).or(be_nil)) }
+
+    it { expect(described_class).to respond_to(:create_from_excon_response).with(1).argument }
+
+    describe "#to_s" do
+      it "is expected to be purty." do
+        expect(Pushover::Response.create_from_excon_response(excon_response).to_s).to include('status')
+      end
+    end
+
+    describe "::create_from_excon_response" do
+      it { expect(Pushover::Response.create_from_excon_response(excon_response)).to be_a_kind_of described_class }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,22 +1,17 @@
 require 'excon'
-require 'pry'
 require 'simplecov'
-require 'simplecov-console'
-
+require 'codecov'
 Excon.defaults[:mock] = true
 
-SimpleCov.formatters = [
-  SimpleCov::Formatter::HTMLFormatter
-]
-
 RSpec.configure do |config|
   config.filter_run :focus
   config.run_all_when_everything_filtered = true
   config.example_status_persistence_file_path = "tmp/examples.txt"
 end
 
-SimpleCov.start do
-  add_filter "/spec/"
-end
+RSpec::Matchers.alias_matcher :return_a_kind_of, :be_a_kind_of
+
+SimpleCov.formatters = [ SimpleCov::Formatter::HTMLFormatter, SimpleCov::Formatter::Codecov]
+SimpleCov.start { add_filter "/spec/" }
 
 require 'pushover'

data/spec/vscode_formatter.rb

@@ -0,0 +1,31 @@
+class VsCodeFormatter
+  RSpec::Core::Formatters.register self, :message, :dump_summary, :dump_failures, :dump_pending, :seed
+
+  def initialize(output)
+    @output = output
+  end
+
+  def message(notification)
+    @output << notification.message
+  end
+
+  def dump_failures(notification)
+    return if notification.failure_notifications.empty?
+
+    notification.failed_examples.each { |e| @output << "error: #{e.full_description} @ #{e.location}" << "\n" }
+  end
+
+  def dump_summary(summary); end
+
+  def dump_pending(notification)
+    return if notification.pending_examples.empty?
+
+    notification.pending_examples.each { |e| @output << "warning: #{e.full_description} @ #{e.location}" << "\n" }
+  end
+
+  def seed(notification)
+    return unless notification.seed_used?
+
+    @output << notification.fully_formatted
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: pushover
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ernie Brodeur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-08 00:00:00.000000000 Z
+date: 2019-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: creatable
+  name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: excon
+  name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,249 +52,45 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov-console
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Api (and CLI) to interface with pushover.net
 email:
 - ebrodeur@ujami.net
 executables:
-- pushover
+- add
 extensions: []
-extra_rdoc_files:
-- CODE_OF_CONDUCT.md
-- README.md
+extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
-- bin/pushover
+- bin/add
+- exe/pushover
 - lib/pushover.rb
-- lib/pushover/api.rb
 - lib/pushover/message.rb
 - lib/pushover/receipt.rb
-- lib/pushover/request.rb
 - lib/pushover/response.rb
 - lib/pushover/version.rb
 - pushover.gemspec
-- spec/lib/pushover/api_spec.rb
-- spec/lib/pushover/message_spec.rb
-- spec/lib/pushover/receipt_spec.rb
-- spec/lib/pushover/request_spec.rb
-- spec/lib/pushover/response_spec.rb
 - spec/lib/pushover_spec.rb
+- spec/pushover/message_spec.rb
+- spec/pushover/receipt_spec.rb
+- spec/pushover/response_spec.rb
 - spec/spec_helper.rb
+- spec/vscode_formatter.rb
 homepage: https://github.com/erniebrodeur/pushover
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options:
-- "--line-numbers"
-- "--inline-source"
-- "--title"
-- Pushover
-- "--main"
-- README.md
-- "--encoding=UTF-8"
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -308,16 +104,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: This spec provides both an API and CLI interface to pushover.net.
 test_files:
-- spec/lib/pushover/api_spec.rb
-- spec/lib/pushover/message_spec.rb
-- spec/lib/pushover/receipt_spec.rb
-- spec/lib/pushover/request_spec.rb
-- spec/lib/pushover/response_spec.rb
 - spec/lib/pushover_spec.rb
+- spec/pushover/message_spec.rb
+- spec/pushover/receipt_spec.rb
+- spec/pushover/response_spec.rb
 - spec/spec_helper.rb
+- spec/vscode_formatter.rb