pushover 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 070ec388b3b147c9cdaa660e44655ed570018779
-  data.tar.gz: '09023c3ab9cbcdf4e87c4363c75c5ab53f30cf74'
+SHA256:
+  metadata.gz: 1535788cd7fdbd24c0e3d8ebb12af8f2b4111e08294f1e3e15ace5113fcae01a
+  data.tar.gz: 8eb169ee1c697ea82af093e8d6c5a75db31664fc3c41c0086f688e300c3e6cc8
 SHA512:
-  metadata.gz: 4f01c3d41f2dd85311e338a205a9fd0909cb5caf3ef0586dc0f81ffef1e843f72dcfa36fa9f38cc63c9835f3a74891e1ffdbeeeaebf21e3a6a7f26c182d81ff2
-  data.tar.gz: ba00579dc02b4a7debe9ad1c4910805dffdf726a6821ca1d18b4ac8e09d02fc6dcca2309ddbc99e46d2bc37e0b16a9d6785901511e2145cbdd464f55c1bd0514
+  metadata.gz: 3356428132d9652dd216de3b45832777a7188c3e144cf1781dccf55b767cf2e25cd4b63d2ce7084b9a5944ab428949bb3299396ff8cf14e251c33bbbf22fe01b
+  data.tar.gz: f345fb5bb6328267be1a48d87a7a5ee218f28d7ce72ca8bb6b64a0ecb4426d057fcf45b17e291eb44a0c449373a7c142efada3a46d09dc436b57b04a46e117e3

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.rubocop.yml

@@ -33,8 +33,9 @@ Metrics/LineLength:
 
 Metrics/BlockLength:
   Exclude:
-    - 'Guardfile'
     - '*.gemspec'
+    - 'Guardfile'
+    - 'Rakefile'
     - 'spec/**/*'
 
 # we exclude these two files since they are generated, the rest of our projects
@@ -59,6 +60,7 @@ Style/FrozenStringLiteralComment:
 Style/MixinUsage:
   Exclude:
   - 'bin/*'
+  - 'exe/*'
 
 # Specs don't need inline documentation.
 Style/Documentation:

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install:
+  - gem install --no-document bundler -v 2.0.1

data/Gemfile

@@ -1,3 +1,30 @@
 source 'https://rubygems.org'
-
 gemspec
+
+gem 'excon'
+gem 'gli'
+gem 'oj'
+gem 'codecov', :require => false, :group => :test
+
+group :test do
+  gem 'bump'
+  gem 'bundler'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop'
+  gem 'rubocop-rspec'
+  gem 'simplecov'
+  gem 'yard'
+end
+
+group :development, optional: true do
+  gem 'guard'
+  gem 'guard-bundler'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'guard-shell'
+  gem 'guard-yard'
+  gem 'pry'
+  gem "pry-inline"
+  gem "solargraph"
+end

data/Guardfile

@@ -1,5 +1,10 @@
 clearing :on
 
+guard :shell do
+  # watch('exe/pushover') { `exe/pushover -h`}
+  watch('exe/pushover') { `exe/pushover message -h` }
+end
+
 guard :bundler do
   require 'guard/bundler'
   require 'guard/bundler/verify'

data/README.md

@@ -1,60 +1,75 @@
 # Pushover
+[![Build Status](https://travis-ci.org/erniebrodeur/pushover.svg?branch=master)](https://travis-ci.org/erniebrodeur/pushover) [![codecov](https://codecov.io/gh/erniebrodeur/pushover/branch/master/graph/badge.svg)](https://codecov.io/gh/erniebrodeur/pushover)
 
-This gem provides a CLI and an API interface to http://pushover.net.
+This gem provides a CLI and an API interface to https://pushover.net.
 
 ## Installation
 
 To install:
 
-  % gem install pushover
+    gem install pushover
 
 To use inside of an application, add this to the your gemfile:
 
-  % gem 'pushover'
+    gem 'pushover'
 
 and run bundle to make it available:
 
-  % bundle
+    bundle
+
 
 ## Usage
 
-## API
+For now, not much is supported on the CLI.
 
-```ruby
-require 'pushover'
-```
+Sending a message:
 
-### Create a message
+    pushover --token=your_app_token --user=user_key message here we go again, on my own.
+    pushover -tyour_app_token -uuser_key message here we go again, on my own.
 
-```ruby
-message = Pushover.create {
-  user: '...',
-  token: '...',
-  message: '...'
-}
-```
+Getting receipt details:
 
-### Send the message
 
-```ruby
-  response = message.send
-```
+    pushover -tyour_app_token receipt receipt-hash
 
-### Response
+Currently unsupported message features:
+ - attachments
+ - callbacks
+ - setting timestamp
 
-- The response will always include `status` and `request`.
-- When set, it will also include `errors` and `receipt`.
 
-```ruby
-  response.status
-  response.request
-```
+### Api
+
+``` ruby
+  require 'pushover'
 
+  ### message
+  message = Pushover::Message.new(token: 'token', user: 'user_key', message: '...')
+  message.push
+
+
+  ### Receipt
+  Pushover::Message.new(token: 'token', user: 'user_key', message: '...', 'priority': 2, expire: 1, retry: 60).push
+
+  receipt = Pushover::Receipt.new(receipt: "receipt", token: 'token')
+  receipt.get
+
+  ### Responses
+  response = Pushover::Message.new(token: 'token', user: 'user_key', message: '...').push
+
+  # the below data is populated from the response
+  puts response.status     # return the status of the request, 0 or 1
+  puts response.request    # uuid of the request
+  puts response.errors     # array of errors (if any)
+  puts response.receipt    # receipt (if requested)
+  puts response.headers    # response headers (includes limits)
+  puts response.attributes # any other k/v pair returned from pushover
+```
 
 ## Contributing
 
 1. Fork it
-2. Switch to development (`git checkout developtment`)
+2. Switch to development (`git checkout development`)
 3. Create your feature branch (`git checkout -b my-new-feature`)
 4. Commit your changes (`git commit -am 'Added some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,6 +1,63 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "open-uri"
+### Configurables
 
-RSpec::Core::RakeTask.new(:spec)
+files = {
+  Gemfile:         'https://gist.githubusercontent.com/erniebrodeur/5a5518f5051210f1828a0712bf623dc8/raw',
+  Rakefile:        'https://gist.githubusercontent.com/erniebrodeur/afc92b72158413aa1f85d8d1facd267a/raw',
+  Rubocop:         'https://gist.githubusercontent.com/erniebrodeur/f7f63996ef1e017aee9bf9d8e680a1df/raw',
+  Tasks:           'https://gist.githubusercontent.com/erniebrodeur/03573fecf4f274101c14f6802abdbe83/raw',
+  BinAdd:          'https://gist.githubusercontent.com/erniebrodeur/a815ee4d8bd9ccc54d91025a5543ebb8/raw',
+  VsCodeFormatter: 'https://gist.githubusercontent.com/erniebrodeur/b24d757c0c625d108019eaceff2234cc/raw'
+}
 
+# spec
+RSpec::Core::RakeTask.new(:spec)
 task default: :spec
+
+# automagical updating
+desc "updates for various bits of the development environment."
+
+namespace :update do
+  desc "update everything (multitasked)"
+  multitask(all: %i[gemfile rakefile rubocop tasks vscode_formatter])
+
+  desc 'Update Gemfile from gist'
+  task :gemfile do
+    grab_file 'Gemfile', files[:Gemfile]
+  end
+
+  desc 'Update Rakefile from gist'
+  task :rakefile do
+    grab_file 'Rakefile', files[:Rakefile]
+  end
+
+  desc 'Update .rubocop.yml from gist'
+  task :rubocop do
+    grab_file '.rubocop.yml', files[:Rubocop]
+  end
+
+  desc 'Update .vscode/tasks.json from gist'
+  task :tasks do
+    mkdir_p '.vscode'
+    grab_file '.vscode/tasks.json', files[:Tasks]
+  end
+
+  desc 'Update vscode_formatter.rb in spec_helper'
+  task :vscode_formatter do
+    mkdir_p 'spec'
+    grab_file 'spec/vscode_formatter.rb', files[:VsCodeFormatter]
+  end
+
+  desc 'Add a new lib and spec file (binary)'
+  task :binadd do
+    mkdir_p 'bin'
+    grab_file 'bin/add', files[:BinAdd]
+  end
+end
+
+def grab_file(filename, uri)
+  File.write filename, OpenURI.open_uri(uri).read
+  puts "Updated #{filename} from: #{uri}"
+end

data/bin/add

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+require 'bundler'
+require 'fileutils'
+
+# add files to lib and spec
+# takes one arg, the path from lib/spec + base filename
+# example: add models/something
+
+unless ARGV[0]
+  puts "example: add models/something"
+  exit
+end
+
+file = ARGV[0].dup
+root = Bundler.root.split.last.to_s
+
+file.chomp!(".rb")
+
+lib = "lib/#{root}/#{file}.rb"
+spec = "spec/#{root}/#{file}_spec.rb"
+
+[lib, spec].each do |s|
+  FileUtils.mkdir_p(File.dirname(s))
+  puts "created: #{FileUtils.touch(s).first}"
+end

data/exe/pushover

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'pushover'
+
+include GLI::App
+
+program_desc 'A simple todo list'
+subcommand_option_handling :normal
+
+flag %i[t token], type: String, desc: 'Application token'
+flag %i[u user], type: String, desc: 'User token'
+
+desc 'send a message'
+command :message do |c|
+  c.flag :device, type: String, desc: 'device to send too'
+  c.flag :title, type: String, desc: 'title of message'
+  c.flag :url, type: String, desc: 'url to include'
+  c.flag :url_title, type: String, desc: 'title of included url'
+  c.flag :priority, type: String, desc: 'numeric priority (-2,-1,0,1,2) from low to high'
+  c.flag :sound, type: String, desc: 'sound, see pushover api for list.'
+  c.flag :expire, type: String, desc: 'how long should a priority message live'
+  c.flag :retry, type: String, desc: 'how often should a resend be attempted (until acknowledged)'
+  c.action do |global_options, options, args|
+    puts Pushover::Message.new({
+      message: args.join(" "), user: global_options[:user], token: global_options[:token]
+    }.merge(GLI::Options.new(options).to_h.reject { |_k, v| v.nil? })).push
+  end
+end
+
+desc 'get a receipt'
+command :receipt do |c|
+  c.action do |global_options, _options, args|
+    puts Pushover::Receipt.new(token: global_options[:token], receipt: args[0]).get
+  end
+end
+
+run(ARGV)

data/lib/pushover.rb

@@ -1,12 +1,14 @@
 require 'oj'
-require 'creatable'
+require 'excon'
 
-require 'pushover/api'
 require 'pushover/message'
-require 'pushover/receipt'
 require 'pushover/response'
-require 'pushover/request'
+require 'pushover/receipt'
 
 # pushover interface for ruby
 module Pushover
+  # headers to include in every request.
+  HEADERS = { 'Content-Type' => 'application/json', 'User-Agent' => "pushover (ruby gem) v#{VERSION}" }.freeze
+  # excon connection to use for every request.
+  Excon = Excon.new('https://api.pushover.net', headers: HEADERS).freeze
 end

data/lib/pushover/message.rb

@@ -1,38 +1,38 @@
-# Pushover interface
 module Pushover
-  class Message
-    include Creatable
-
-    attribute name: 'attachment'
-    attribute name: 'device', kind_of: String
-    attribute name: 'html', kind_of: TrueClass
-    attribute name: 'message', kind_of: String
-    attribute name: 'priority', kind_of: String
-    attribute name: 'sound', kind_of: String
-    attribute name: 'timestamp', kind_of: Numeric
-    attribute name: 'title', kind_of: String
-    attribute name: 'token', kind_of: String
-    attribute name: 'response', kind_of: Pushover::Response
-    attribute name: 'url_title', kind_of: String
-    attribute name: 'url', kind_of: String
-    attribute name: 'user', kind_of: String
-
-    def initialize
-      @timestamp = Time.now.to_i
-    end
-
+  # Message is a struct to send a message to pushover.
+  # @!attribute [rw] token
+  #   @return [String] application token
+  # @!attribute [rw] user
+  #   @return [String] user key
+  # @!attribute [rw] message
+  #   @return [String] message to transmit
+  # @!attribute [rw] device
+  #   @return [String] device to transmit too
+  # @!attribute [rw] title
+  #   @return [String] title of the message
+  # @!attribute [rw] url
+  #   @return [String] supplementary url
+  # @!attribute [rw] url_title
+  #   @return [String] title of the supplementary url
+  # @!attribute [rw] priority
+  #   @return [Numeric] numeric value for priority.
+  # @!attribute [rw] sound
+  #   @return [String] sound to play
+  # @!attribute [rw] timestamp
+  #   @return [Numeric] timestamp to expire, in epoch
+  # @!attribute [rw] expire
+  #   @return [Numeric] expire time until message expires
+  # @!attribute [rw] retry
+  #   @return [Numeric] how long to retry for, in seconds
+  # @!attribute [rw] callback
+  #   @return [String] callback url
+  Message = Struct.new(:token, :user, :message, :attachment, :device, :title, :url, :url_title, :priority, :sound, :timestamp, :expire, :retry, :callback, keyword_init: true) do
+    # push the configured message to pushover.
+    #   @return [Response] response for the receipt request
     def push
-      raise ArgumentError, 'user is a required parameter' unless user
-      raise ArgumentError, 'token is a required parameter' unless token
-      raise ArgumentError, 'message is a required parameter' unless message
-
-      query = {}
-
-      attributes.each { |e| query.store e[:name], instance_variable_get("@#{e[:name]}") if instance_variable_get("@#{e[:name]}") }
+      %i[token user message].each { |param| raise "#{param} must be supplied" unless send param }
 
-      response = Request.create.push(:messages, query)
-      response.process
-      @response = response
+      Response.create_from_excon_response Excon.post(path: '1/messages.json', query: to_h)
     end
   end
 end