pushover2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49568c6d155d41bf796bae5ea5fe5928f32343ece725756aac8691dbd1e0e094
+  data.tar.gz: fc1af9923a1d53734dc2596010fd2f787b7f4c2ecdbaaa931fc515490439d395
+SHA512:
+  metadata.gz: 05bddbcaed195ce3782edd30259134728a8d344a00cc2818e0d94a56977c99c49892bca0b973dae0b05e048317758014bc3eca469df0eeb68dda94573b2f8b13
+  data.tar.gz: 626babddd33cf9e4c4f64a9ef0d57092f86a3f195a0d79c90222970aed743599c7cd931f84773626be37c8967f6e6b1795d4f81785b79b9e8965e0fc7caa75b5

data/.rubocop.yml

@@ -0,0 +1,21 @@
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.4.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Igor Zubkov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Pushover2
+
+Pushover.net Ruby API Client.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add pushover2
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install pushover2
+```
+
+## Usage
+
+```ruby
+require "pushover2"
+
+# Send message
+message = Pushover2::Message.new(token: "app-token", user: "user-token", message: "...")
+message.push
+
+# Send to device
+message = Pushover2::Message.new(token: "app-token", user: "user-token", message: "...", device: "iphone")
+message.push
+
+# Send html message
+message = Pushover2::Message.new(token: "app-token", user: "user-token", message: "<b>Hello</b>", html: 1)
+message.push
+
+# Send silent message
+message = Pushover2::Message.new(token: "app-token", user: "user-token", message: "...", sound: "none")
+message.push
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/biow0lf/pushover2.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/pushover2/client.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "json"
+
+module Pushover2
+  class Client
+    BASE_URI = "https://api.pushover.net"
+
+    # @param path [String]
+    def post(path, query: {}, body: {})
+      make_request(path, body: body)
+    end
+
+    def make_request(path, body: {})
+      uri = URI("#{BASE_URI}#{path}")
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      request = Net::HTTP::Post.new(uri.request_uri, {
+        "Content-Type": "application/x-www-form-urlencoded"
+      })
+      request.set_form_data(body)
+
+      response = http.request(request)
+
+      puts JSON.parse(response.body)
+    end
+  end
+end

data/lib/pushover2/message.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Pushover2
+  class Message
+    MESSAGE_PATH = "/1/messages.json"
+
+    # Instance of Pushover2::Client
+    attr_reader :client
+
+    # Application Token (how is sending message)
+    attr_reader :token
+
+    # User Token (how is receiving message)
+    attr_reader :user
+
+    # String to send
+    attr_reader :message
+
+    attr_reader :attachment
+    attr_reader :attachment_base64
+    attr_reader :attachment_type
+    attr_reader :device
+    attr_reader :html
+    attr_reader :priority
+    attr_reader :sound
+    attr_reader :timestamp
+    attr_reader :title
+    attr_reader :ttl
+    attr_reader :url
+    attr_reader :url_title
+
+    # @param token [String] Application Token (how is sending message). Required.
+    # @param user [String] User Token (how is receiving message). Required.
+    # @param message [String] String to send. Required.
+    # @param attachment [] Optional.
+    # @param attachment_base64 [] Optional.
+    # @param attachment_type [] Optional.
+    # @param device [String, nil] Device name to send notification. Optional.
+    # @param html [Integer, nil] If set to 1, send html formatted message. Optional.
+    # @param priority [Integer, nil] One from: -2, -1, 0, 1, 2. Default: 0. Optional.
+    # @param sound [String, nil] Sound to play. Default: "pushover". Optional.
+    # @param timestamp [] Optional.
+    # @param title [String, nil] Title for notification. Optional.
+    # @param ttl [Integer, nil] TTL for notification in seconds. Optional.
+    # @param url [String, nil] URL for notification. Optional.
+    # @param url_title [String, nil] Title for notification URL. Optional.
+    def initialize(token:, user:, message:,
+      attachment: nil,
+      attachment_base64: nil,
+      attachment_type: nil,
+      device: nil,
+      html: nil,
+      priority: nil,
+      sound: nil,
+      timestamp: nil,
+      title: nil,
+      ttl: nil,
+      url: nil,
+      url_title: nil)
+      @client = Client.new
+      @token = token
+      @user = user
+      @message = message
+      @attachment = attachment
+      @attachment_base64 = attachment_base64
+      @attachment_type = attachment_type
+      @device = device
+      @html = html
+      @priority = priority
+      @sound = sound
+      @timestamp = timestamp
+      @title = title
+      @ttl = ttl
+      @url = url
+      @url_title = url_title
+    end
+
+    def push
+      client.post(MESSAGE_PATH, body: body)
+    end
+
+    private
+
+    def body
+      payload = {
+        token: token,
+        user: user,
+        message: message,
+        attachment: attachment,
+        attachment_base64: attachment_base64,
+        attachment_type: attachment_type,
+        device: device,
+        html: html,
+        priority: priority,
+        sound: sound,
+        timestamp: timestamp,
+        title: title,
+        ttl: ttl,
+        url: url,
+        url_title: url_title
+      }.compact
+
+      if payload[:token].nil?
+        raise "Missing required :token field"
+      end
+
+      if payload[:user].nil?
+        raise "Missing required :user field"
+      end
+
+      if payload[:message].nil?
+        raise "Missing required :message field"
+      end
+
+      payload
+    end
+  end
+end

data/lib/pushover2/sounds.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Pushover2
+  SOUNDS = [
+    "pushover",
+    "bike",
+    "bugle",
+    "cashregister",
+    "classical",
+    "cosmic",
+    "falling",
+    "gamelan",
+    "incoming",
+    "intermission",
+    "magic",
+    "mechanical",
+    "pianobar",
+    "siren",
+    "spacealarm",
+    "tugboat",
+    "alien",
+    "climb",
+    "persistent",
+    "echo",
+    "updown",
+    "vibrate",
+    "none"
+  ].freeze
+end

data/lib/pushover2/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pushover2
+  VERSION = "0.1.0"
+end

data/lib/pushover2.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "pushover2/version"
+require_relative "pushover2/sounds"
+require_relative "pushover2/client"
+require_relative "pushover2/message"
+
+module Pushover2
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: pushover2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ihor Zubkov
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: webmock
+  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: vcr
+  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: Ruby API for pushover.net.
+email:
+- igor.zubkov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pushover2.rb
+- lib/pushover2/client.rb
+- lib/pushover2/message.rb
+- lib/pushover2/sounds.rb
+- lib/pushover2/version.rb
+homepage: https://github.com/biow0lf/pushover2
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/biow0lf/pushover2
+  source_code_uri: https://github.com/biow0lf/pushover2
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.0
+specification_version: 4
+summary: Ruby API for pushover.net
+test_files: []