simplepush 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c13cefedbd1151589a852fa4f91c1f43a2ad117d01b56752fad35959cc1c3a21
+  data.tar.gz: fde8e2a819e41a5de6c9d82142e045567f22fcf6b9a31b25b119a2ffdba8ddf8
+SHA512:
+  metadata.gz: 044447bdfd5f5c08b441e537dc2a5984c64a005a15d49b714714f21ce62f45d21ee4a23ab10dd96ad959139c03c3ae30d153d4629de7b92e8eb059036d351307
+  data.tar.gz: fd381bafb1e625c9a64308f7becf9c29623ddbb896c9a906fd4aa9f50e68d9f8a0937f6d66f81b0ad84f19ecb5ad1b4e9755aff7148318f11debeb5a17191ec4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/example/push.sh
+/config.yml

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simplepush.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "async"

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    simplepush (0.6.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    async (1.30.1)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    console (1.13.1)
+      fiber-local
+    fiber-local (1.0.0)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    multi_xml (0.6.0)
+    nio4r (2.5.8)
+    rake (13.0.6)
+    timers (4.3.3)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  async
+  rake (~> 13.0)
+  simplepush!
+
+BUNDLED WITH
+   2.2.5

data/README.md

@@ -0,0 +1,109 @@
+# Simplepush Gem for Ruby
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/simplepush`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplepush'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install simplepush
+```
+
+Add as a dependency:
+
+```ruby
+require 'simplepush'
+```
+
+## Usage
+
+```ruby
+# From example/example.rb
+require 'simplepush'
+
+Simplepush.new('<your key>').send("Title", "Message") # Unenrypted
+
+Simplepush.new('<your key>', "<pass>", "<salt>").send("Title", "Message") # Enrypted
+
+```
+
+## Asynchronous send
+
+The following does not work... `#TODO`
+
+```ruby
+require 'async' # gem 'async'
+
+s = Simplepush.new('<your key>')
+
+Sync do
+  100.times do |i|
+    Async do
+      s.send("Title", i.to_s) # Unenrypted
+    end
+  end
+end
+```
+
+## Example of query
+
+The following is a sample of the query as it is produced:
+
+```json
+{
+  "args": {},
+  "data": "",
+  "files": {},
+  "form": {
+    "encrypted": "true",
+    "iv": "CEEFFBE72CC70DF45480DDAC775743B6",
+    "key": "<the key, the key>",
+    "msg": "szR70wqD9g8T2nX0FRZwoQ=="
+  },
+  "headers": {
+    "Accept": "*/*",
+    "Accept-Encoding": "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
+    "Content-Length": "94",
+    "Content-Type": "application/x-www-form-urlencoded",
+    "Host": "httpbin.org",
+    "User-Agent": "Ruby",
+    "X-Amzn-Trace-Id": "Root=1-617714e4-08fc2a3f349df4203121ce0e"
+  },
+  "json": null,
+  "origin": "91.32.103.70",
+  "url": "https://httpbin.org/post"
+}
+```
+
+## Todos
+
+ - [x] Encrypted Messages
+ - [x] Processing responses
+ - [x] Async calls
+ - [ ] Example how to integrate into rails to notify of failures
+
+## Changelog
+
+ - 0.5.0 Initial Commits
+ - 0.6.0 Changing API to cache keys, better examples
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/coezbek/simplepush
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "simplepush"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/async.rb

@@ -0,0 +1,28 @@
+
+require_relative 'config.rb'
+
+config = load_config
+simplepush = Simplepush.new(config[:key])
+
+n = 10
+if 3 >= RUBY_VERSION.split(".").first.to_i
+
+  require 'async'
+  Sync do
+    n.times do |i|
+      Async do
+       simplepush.send("Asynchronous sending with Async", i.to_s)
+      end
+    end
+  end # join here
+
+else
+
+  threads = Array.new(n) { |i|
+    Thread.new {
+      simplepush.send("Asynchronous sending with Threads", i.to_s)
+    }
+  }
+  threads.each(&:join)
+
+end

data/example/config.rb

@@ -0,0 +1,24 @@
+require_relative '../lib/simplepush'
+
+def load_config
+  if !File.exists?('config.yml')
+
+    config = {}
+
+    puts "Enter your key"
+    config[:key] = gets[/.+/] # Strip newline and return nil if ""
+
+    puts "Enter your password or leave empty to send unencrypted"
+    config[:pass] = gets[/.+/]
+
+    if config[:pass]
+      puts "Enter the salt"
+      config[:salt] = gets[/.+/]
+    end
+
+    puts "Configuration stored (as plaintext) in config.yml"
+    File.write('config.yml', config.to_yaml)
+  end
+
+  YAML.load_file('config.yml')
+end

data/example/example.rb

@@ -0,0 +1,18 @@
+
+require_relative 'config.rb'
+
+config = load_config
+
+puts "Please enter your message"
+message = gets.strip
+
+puts "Should this message be encrypted? (y or n)"
+
+simplepush = if gets =~ /n/i
+  Simplepush.new(config[:key])
+else
+  Simplepush.new(config[:key], config[:pass], config[:salt])
+end
+
+simplepush.send('Message from Example.rb', message)
+

data/lib/simplepush/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Simplepush
+  VERSION = "0.6.0"
+end

data/lib/simplepush.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "simplepush/version"
+require 'httparty'
+
+class Simplepush
+
+  include HTTParty
+
+  base_uri 'https://api.simplepush.io'.freeze
+  # For testing:
+  # base_uri 'https://httpbin.org'.freeze
+  format :json
+  default_timeout 5 # 5 seconds
+  # debug_output $stdout # Uncomment to get detailled httparty log output to stdout 
+
+  # If password and salt are provided, then message and title will be encrypted.
+  def initialize(key, password = nil, salt = '1789F0B8C4A051E5')
+    raise "Key must be set" unless key
+    @key = key
+    @cipher_key = [Digest::SHA1.hexdigest(password + salt)[0,32]].pack "H*" if password
+  end
+
+  #
+  # Send the given title/message.
+  #
+  # This method is blocking.
+  #
+  def send(title, message, event = nil)
+    raise "Key and message argument must be set" unless message
+
+    payload = {}
+    payload[:key] = @key
+    payload[:msg] = message.to_s
+    payload[:event] = event.to_s if event
+    payload[:title] = title.to_s if title
+
+    if @cipher_key
+      require 'openssl'
+      payload[:encrypted] = true
+
+      cipher = OpenSSL::Cipher::AES.new(128, :CBC)
+      cipher.encrypt
+      cipher.key = @cipher_key
+
+      # Set random_iv and store as payload
+      payload[:iv] = cipher.random_iv.unpack("H*").first.upcase
+
+      # Automatically uses PKCS7
+      payload[:msg] = Base64.urlsafe_encode64(cipher.update(payload[:msg]) + cipher.final)
+
+      if title
+        cipher.encrypt # Restart cipher
+        payload[:title] = Base64.urlsafe_encode64(cipher.update(payload[:title]) + cipher.final)
+      end
+    end
+
+    return self.class.post('/send', body: payload)
+  end
+
+end

data/simplepush.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/simplepush/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simplepush"
+  spec.version       = Simplepush::VERSION
+  spec.authors       = ["Christopher Oezbek"]
+  spec.email         = ["c.oezbek@gmail.com"]
+
+  spec.summary       = "Ruby SimplePush.io API client (unofficial)"
+  spec.description   = "Httpary wrapper for SimplePush.io"
+  spec.homepage      = "https://github.com/coezbek/simplepush"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/coezbek/simplepush/README.md#Changelog"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency "httparty"
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: simplepush
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Christopher Oezbek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+description: Httpary wrapper for SimplePush.io
+email:
+- c.oezbek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/async.rb
+- example/config.rb
+- example/example.rb
+- lib/simplepush.rb
+- lib/simplepush/version.rb
+- simplepush.gemspec
+homepage: https://github.com/coezbek/simplepush
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/coezbek/simplepush
+  source_code_uri: https://github.com/coezbek/simplepush
+  changelog_uri: https://github.com/coezbek/simplepush/README.md#Changelog
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Ruby SimplePush.io API client (unofficial)
+test_files: []