njiuko-pwush 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60a9a2ea8e0265c8f275ca51a36f9b1517eaedf47862d70b46743a019af1bea9
+  data.tar.gz: 811e46470701ee7345311d173f2a4896fd2edb2f8b6d8044404aadbbfd5cab66
+SHA512:
+  metadata.gz: 1235a03026893de2de7e4c9c514075d131eb80ec5de457f9a051418ee8aff03afbe0830574d445a670de12d93e2e099390277d0d659a165bc2f765e932ddca5e
+  data.tar.gz: 6a7cc440e151f4276f9e53e4b0118702cc73829c1a7df6e1e68e30c122099412a0f36c19b5e67ebef041f45abbff6c462ac9ab5f9070708d275626748f8cb4a8

data/.circleci/config.yml

@@ -0,0 +1,64 @@
+version: 2.0
+defaults: &default_job
+  working_directory: ~/repo
+
+  docker:
+    - image: circleci/ruby:2.4-node-browsers
+
+  steps:
+    - checkout
+
+    # - type: cache-restore
+    #   name: Restore bundle cache
+    #   key: pwush-{{ checksum "Gemfile.lock" }}
+
+    - run:
+        name: install dependencies
+        command: |
+          bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+    # - type: cache-save
+    #   name: Store bundle cache
+    #   key: pwush-{{ checksum "Gemfile.lock" }}
+    #   paths:
+    #     - vendor/bundle
+
+    - run:
+        name: Download cc-test-reporter
+        command: |
+          mkdir -p tmp/
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./tmp/cc-test-reporter
+          chmod +x ./tmp/cc-test-reporter
+
+    - run:
+        name: Run tests
+        command: |
+          bundle exec rake
+          ./tmp/cc-test-reporter format-coverage -t simplecov -o tmp/codeclimate.json
+
+    - run:
+        name: Upload coverage results to Code Climate
+        command: |
+          ./tmp/cc-test-reporter upload-coverage -i tmp/codeclimate.json -r ce337e25b76b0c3048abfdb2d5aa6d3e87cc8540d90f0029ef7416683814732e
+
+jobs:
+  ruby-2.4:
+    <<: *default_job
+    docker:
+      - image: circleci/ruby:2.4-node-browsers
+  ruby-2.5:
+    <<: *default_job
+    docker:
+      - image: circleci/ruby:2.5-node-browsers
+  ruby-2.6:
+    <<: *default_job
+    docker:
+      - image: circleci/ruby:2.6-node-browsers
+
+workflows:
+  version: 2
+  multiple-rubies:
+    jobs:
+      - ruby-2.4
+      - ruby-2.5
+      - ruby-2.6

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.7.4

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Change Log
+
+## [0.3.0](https://github.com/iarie/pwush/tree/HEAD)
+- Update Dry-Struct runtime dependecy to 1.0
+- Drop ruby 2.3 support
+
+## [0.2.0](https://github.com/iarie/pwush/tree/HEAD)
+
+**Added:**
+- Introduce devices api [\#4](https://github.com/iarie/pwush/pull/4) ([iarie](https://github.com/iarie))
+
+## [0.1.2](https://github.com/iarie/pwush/tree/HEAD)
+
+**Changed:**
+- Update dry-rb gems [\#3](https://github.com/iarie/pwush/pull/3)
+
+## [0.1.1](https://github.com/iarie/pwush/tree/HEAD)
+
+**Added:**
+- timeout config options added [\#1](https://github.com/iarie/pwush/pull/1) ([achernik](https://github.com/achernik))

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at litvinov@applicot.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pw.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Yaroslav Litvinov
+
+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,72 @@
+[![CircleCI](https://circleci.com/gh/iarie/pwush/tree/master.svg?style=shield)](https://circleci.com/gh/iarie/pwush/tree/master)
+[![Gem Version](https://badge.fury.io/rb/pwush.svg)](https://badge.fury.io/rb/pwush)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d1887381dee84e26e860/maintainability)](https://codeclimate.com/github/iarie/pwush/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d1887381dee84e26e860/test_coverage)](https://codeclimate.com/github/iarie/pwush/test_coverage)
+
+# Pwush
+
+Pwush is a remote api toolkit for [Pushwoosh](https://www.pushwoosh.com/v1.0/reference)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pwush', '~> 0.3.0'
+```
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install pwush
+
+## Basic Usage
+
+### Setup pwush client
+```ruby
+MyPW = Pwush.new(auth: 'AUTH_KEY', app: 'APP_CODE', timeout: { connect: 5, read: 10, write: 2 })
+```
+### Push message
+```ruby
+MyPW.create_message(content: 'Hello, there!')
+```
+### Using built-in struct
+```ruby
+first_message = Pwush::Message.new(
+  content: { en: 'Hello' },
+  send_date: '2018-04-06 23:00',
+  timezone: 'Europe/London',
+  devices: ['token1', 'token2'],
+  ios_title: 'This is the test message',
+  ios_subtitle: 'subtitle!'
+)
+
+second_message = Pwush::Message.new(
+  content: { es: 'Hola' },
+  send_date: '2018-04-06 23:00',
+  timezone: 'Europe/Madrid',
+  devices: ['token3', 'token4'],
+  android_banner: 'This is the test message',
+  android_gcm_ttl: 3600
+)
+
+MyPW.push(first_message, second_message)
+```
+
+### Result
+The result is `dry-monads` Success or Failure, [read about it](http://dry-rb.org/gems/dry-monads/result/)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iarie/pwush. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PwRb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/iarie/pwush/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pwush'
+
+# 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

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/lib/pwush/api/applications.rb

@@ -0,0 +1,9 @@
+module Pwush
+  module Api
+    module Applications
+      def applications
+        post(:getApplications)
+      end
+    end
+  end
+end

data/lib/pwush/api/devices.rb

@@ -0,0 +1,41 @@
+module Pwush
+  module Api
+    module Devices
+      def register_device(params)
+        post(:registerDevice, params)
+      end
+
+      def unregister_device(hwid)
+        post(:unregisterDevice, hwid: hwid)
+      end
+
+      def create_test_device(params)
+        post(:createTestDevice, params)
+      end
+
+      def list_test_devices
+        post(:listTestDevices)
+      end
+
+      def set_badge(hwid, badge)
+        post(:setBadge, hwid: hwid, badge: badge)
+      end
+
+      def application_open(hwid)
+        post(:applicationOpen, hwid: hwid)
+      end
+
+      def push_stat(hwid, hash_tag = nil)
+        post(:pushStat, hwid: hwid, hash: hash_tag)
+      end
+
+      def message_delivery_event(hwid, hash_tag = nil)
+        post(:messageDeliveryEvent, hwid: hwid, hash: hash_tag)
+      end
+
+      def set_purchase(hwid, params = {})
+        post(:setPurchase, params.merge(hwid: hwid))
+      end
+    end
+  end
+end

data/lib/pwush/api/messages.rb

@@ -0,0 +1,30 @@
+module Pwush
+  module Api
+    module Messages
+      def create_message(*messages)
+        post(:createMessage, notifications: messages.flatten)
+      end
+      alias push create_message
+
+      def delete_message(message_code)
+        post(:deleteMessage, message: message_code)
+      end
+
+      def message_details(message)
+        post(:getMessageDetails, message: message)
+      end
+
+      def message_stats(message)
+        post(:getMsgStats, message: message)
+      end
+
+      def results(request_id)
+        post(:getResults,  request_id: request_id)
+      end
+
+      def preset(preset_code)
+        post(:getPreset, preset_code: preset_code)
+      end
+    end
+  end
+end

data/lib/pwush/client.rb

@@ -0,0 +1,50 @@
+require 'http'
+
+require 'pwush/api/messages'
+require 'pwush/api/devices'
+require 'pwush/api/applications'
+
+module Pwush
+  class Client
+    include Api::Messages
+    include Api::Devices
+    include Api::Applications
+
+    def initialize(options)
+      @config = Config.new(options)
+    end
+
+    private
+
+    def get(action, payload = nil)
+      perform_request(:get, action, payload)
+    end
+
+    def post(action, payload = nil)
+      perform_request(:post, action, payload)
+    end
+
+    def perform_request(verb, action, payload)
+      Response.wrap { raw_request(verb, action, payload) }
+    end
+
+    def raw_request(verb, action, payload)
+      request = build_request(payload)
+      url     = url(action)
+
+      @config.logger.info(
+        "Pushwoosh #{verb.upcase} #{url} BODY #{request.body.to_json}"
+      )
+
+      HTTP.timeout(@config.timeout).request(verb, url, json: request.body)
+    end
+
+    def build_request(payload = nil)
+      Request.new(auth: @config.auth, app: @config.app, payload: payload)
+    end
+
+    def url(action)
+      [@config.url, action].join('/')
+    end
+  end
+end

data/lib/pwush/config.rb

@@ -0,0 +1,30 @@
+require 'logger'
+
+module Pwush
+  MissingAuthToken = Class.new(StandardError)
+  MissingAppToken = Class.new(StandardError)
+
+  class Config
+    URL = 'https://cp.pushwoosh.com/json/1.3'.freeze
+
+    def initialize(options = {})
+      @url     = options[:url]     || URL
+      @auth    = options[:auth]    || auth_missing
+      @app     = options[:app]     || app_missing
+      @timeout = options[:timeout] || { write: 2, connect: 5, read: 10 }
+      @logger  = options[:logger]  || Logger.new(STDOUT)
+    end
+
+    attr_accessor :auth, :url, :app, :timeout, :logger
+
+    private
+
+    def auth_missing
+      raise(MissingAuthToken, 'please provide :auth argument')
+    end
+
+    def app_missing
+      raise(MissingAppToken, 'please provide :app argument')
+    end
+  end
+end

data/lib/pwush/message.rb

@@ -0,0 +1,312 @@
+module Pwush
+  class Message < Dry::Struct
+    # transform_types do |type|
+    #   type.constructor { |value| value.nil? ? Undefined : value }
+    # end
+    # https://www.pushwoosh.com/v1.0/reference#createmessage
+
+    # YYYY-MM-DD HH:mm  OR 'now'
+    attribute :send_date, Types::Strict::String.default('now'.freeze)
+
+    attribute :ignore_user_timezone, Types::Strict::Bool.default(true)
+
+    # "timezone":"America/New_York", optional, if ignored UTC-0 is default in "send_date".
+    # See http://php.net/manual/timezones.php for supported timezones
+    attribute? :timezone, Types::Strict::String
+
+    # "campaign":"CAMPAIGN_CODE", optional.
+    # Campaign code to which you want to assign this push message
+    attribute? :campaign, Types::Strict::String
+
+    # "content":{
+    #    "en":"English",
+    #    "ru":"Русский",
+    #    "de":"Deutsch"
+    # },
+    attribute :content, Types::Strict::String | Types::Hash
+
+    #  "page_id": 39, optional. HTML Pages. integer
+    attribute? :page_id, Types::Strict::Integer
+
+    # "rich_page_id": 42, optional. Rich Pages. integer
+    attribute? :rich_page_id, Types::Strict::Integer
+
+    # "rich_media": "XXXX-XXXX", optional. Rich Media code. string
+    attribute? :rich_media, Types::Strict::String
+
+    # "remote_page" : "http://myremoteurl.com",
+    # Remote Rich HTML Page URL. <scheme>://<authority>
+    attribute? :remote_page, Types::Strict::String
+
+    # "link": "http://google.com", optional, string.
+    # For deeplinks add "minimize_link":0
+    attribute? :link, Types::Strict::String
+
+    # "minimize_link": 0, optional.
+    # False or 0 - do not minimize, 1 - Google, 2 - bitly. Default = 1
+    attribute? :minimize_link, Types::Strict::Integer.constrained(included_in: 0..2)
+
+    # "data": {"key":"value"}, JSON string or JSON object,
+    # will be passed as "u" parameter in the payload (converted to JSON string)
+    attribute? :data, Types::Strict::String | Types::Hash
+
+    # 1 - iOS; 2 - BB; 3 - Android; 5 - Windows Phone; 7 - OS X; 8 - Windows 8;
+    # 9 - Amazon; 10 - Safari; 11 - Chrome; 12 - Firefox;
+    # ignored if "devices" < 10
+    Platforms = Types::Strict::Integer.enum(1, 2, 3, 5, 7, 8, 9, 10, 11, 12)
+    attribute? :platforms, Types::Strict::Array.of(Platforms)
+
+    # "preset":"Q1A2Z-6X8SW", Push Preset Code from your Control Panel
+    attribute? :preset, Types::Strict::String
+
+    # "send_rate": 100, throttling. Valid values are from 100 to 1000 pushes/second.
+    attribute? :send_rate, Types::Strict::Integer.constrained(included_in: 100..1000)
+
+    # Optional. Specify tokens or hwids to send targeted push notifications.
+    # Not more than 1000 tokens/hwids in an array.
+    # If set, the message will only be sent to the devices on the list.
+    # Ignored if the Applications Group is used. iOS push tokens can only be lower case.
+    attribute? :devices, Types::Strict::Array.of(Types::Strict::String)
+
+    # "users":["user_3078a"], optional.
+    # If set, message will only be delivered to the specified users Id's
+    # (specified via /registerUser call).
+    # If specified together with devices parameter, the latter will be ignored.
+    attribute? :users, Types::Strict::Array.of(Types::Strict::String)
+
+    #  "filter": "FILTER_NAME", optional.
+    attribute? :filter, Types::Strict::String
+
+    #  optional, placeholders for dynamic content instead of device tags
+    #  "dynamic_content_placeholders" :{
+    #      "firstname":"John",
+    #      "lastname":"Doe"
+    #  },
+    attribute? :dynamic_content_placeholders, Types::Hash
+
+    # "conditions": [TAG_CONDITION1, TAG_CONDITION2, ..., TAG_CONDITIONN],
+    # Optional.
+    attribute? :conditions, Types::Strict::Array.of(Types::Strict::String)
+
+    # iOS related
+
+    # "ios_badges": 5, optional, integer.
+    # iOS application badge number.
+    # Use "+n" or "-n" to increment/decrement the badge value by n
+    attribute? :ios_badges, Types::Strict::Integer
+
+    # "ios_sound": "sound file.wav", optional.
+    # Sound file name in the main bundle of application.
+    # If left empty, the device will produce no sound upon receiving a push
+    attribute? :ios_sound, Types::Strict::String
+
+    # "ios_ttl": 3600, optional.
+    # Time to live parameter - maximum message lifespan in seconds
+    attribute? :ios_ttl, Types::Strict::Integer
+
+    # "ios_silent": 1, optional.
+    # Enable silent notifications (ignore "sound" and "content")
+    attribute? :ios_silent, Types::Strict::Integer.constrained(included_in: 0..1)
+
+    # iOS8 category ID from Pushwoosh
+    attribute? :ios_category_id, Types::Strict::Integer
+
+    # Optional - root level parameters to the aps dictionary
+    # "ios_root_params" : {
+    #    "aps":{
+    #      "content-available": "1",
+    #      "mutable-content":1 //required for iOS 10 Media attachments
+    #   },
+    #    "attachment":"YOUR_ATTACHMENT_URL", // iOS 10 media attachment URL
+    #   "data": << User supplied data, max of 4KB>>
+    #  },
+    attribute? :ios_root_params, Types::Hash
+
+    #  "apns_trim_content":1, optional. (0|1)
+    # Trims the exceeding content strings with ellipsis
+    attribute? :apns_trim_content, Types::Strict::Integer.constrained(included_in: 0..1)
+
+    # "ios_title":"Title", optional. Add Title for push notification
+    attribute? :ios_title, Types::Strict::String
+
+    # "ios_subtitle" : "SubTitle", //Optional. Added sub-title for push notification
+    attribute? :ios_subtitle, Types::Strict::String
+
+    # Android related
+
+    # "android_root_params": {"key": "value"}
+    # custom key-value object. root level parameters for the android payload recipients
+    attribute? :android_root_params, Types::Hash
+
+    # "android_sound" : "soundfile", optional. No file extension.
+    # If left empty, the device will produce no sound upon receiving a push
+    attribute? :android_sound, Types::Strict::String
+
+    # "android_header":"header", optional. Android notification header
+    attribute? :android_header, Types::Strict::String
+
+    # "android_icon": "icon",
+    attribute? :android_icon, Types::Strict::String
+
+    # "android_custom_icon": "http://example.com/image.png", optional.
+    # Full path URL to the image file
+    attribute? :android_custom_icon, Types::Strict::String
+
+    # "android_banner": "http://example.com/banner.png", optional.
+    # Full path URL to the image file
+    attribute? :android_banner, Types::Strict::String
+
+    # "android_badges": 5, optional, integer.
+    # Android application icon badge number.
+    # Use "+n" or "-n" to increment/decrement the badge value by n
+    attribute? :android_badges, Types::Strict::Integer
+
+    # "android_gcm_ttl": 3600, optional.
+    # Time to live parameter - maximum message lifespan in seconds
+    attribute? :android_gcm_ttl, Types::Strict::Integer
+
+    # "android_vibration": 0, Android force-vibration for high-priority pushes, boolean
+    attribute? :android_vibration, Types::Strict::Bool
+
+    # "android_led":"#rrggbb", LED hex color, device will do its best approximation
+    attribute? :android_led, Types::Strict::String
+
+    # "android_priority":-1,  priority of the push in the Android push drawer.
+    # Valid values are -2, -1, 0, 1 and 2
+    attribute? :android_priority, Types::Strict::Integer.constrained(included_in: -2..2)
+
+    # "android_ibc":"#RRGGBB", icon background color on Lollipop,
+    # #RRGGBB, #AARRGGBB, "red", "black", "yellow", etc.
+    attribute? :android_ibc, Types::Strict::String
+
+    # "android_silent": 1, optional. 0 or 1
+    # Enable silent notificaiton (ignore sound and content)
+    attribute? :android_silent, Types::Strict::Integer.constrained(included_in: 0..1)
+
+    # Amazon related
+
+    # "adm_root_params": {"key": "value"}, // custom key-value object
+    attribute? :adm_root_params, Types::Hash
+    # "adm_sound": "push.mp3",
+    attribute? :adm_sound, Types::Strict::String
+    # "adm_header": "Header",
+    attribute? :adm_header, Types::Strict::String
+    # "adm_icon": "icon",
+    attribute? :adm_icon, Types::Strict::String
+    # "adm_custom_icon": "http://example.com/image.png",
+    attribute? :adm_custom_icon, Types::Strict::String
+    # "adm_banner": "http://example.com/banner.png",
+    attribute? :adm_banner, Types::Strict::String
+    # "adm_ttl": 3600, optional. Time to live parameter - the maximum message lifespan in seconds
+    attribute? :adm_ttl, Types::Strict::Integer
+    # "adm_priority":-1, priority of the push in Amazon push drawer, valid values are -2, -1, 0, 1 and 2
+    attribute? :adm_priority, Types::Strict::Integer.constrained(included_in: -2..2)
+
+    # Windows Phone related
+
+    # Windows Phone notification type. 'Tile' or 'Toast'. Raw notifications are not supported. 'Tile' if default
+    attribute? :wp_type, Types::Strict::String
+    # tile image
+    attribute? :wp_background, Types::Strict::String
+    # back tile image
+    attribute? :wp_backbackground, Types::Strict::String
+    # back tile title
+    attribute? :wp_backtitle, Types::Strict::String
+    # back tile content
+    attribute? :wp_backcontent, Types::Strict::String
+    # Badge for Windows Phone notification
+    attribute? :wp_count, Types::Strict::Integer
+
+    # BlackBerry related
+
+    # BlackBerry header, applicable to BB10 Series devices
+    attribute? :blackberry_header, Types::Strict::String
+
+    # Mac OS X related
+
+    # "mac_badges": 3,
+    attribute? :mac_badges, Types::Strict::Integer
+    # "mac_sound": "sound.caf",
+    attribute? :mac_sound, Types::Strict::String
+    # "mac_root_params": {"content-available":1},
+    attribute? :mac_root_params, Types::Hash
+    # Time to live parameter — maximum message lifespan in seconds
+    attribute? :mac_ttl, Types::Strict::Integer
+
+    # WNS related
+
+    # Content (XML or raw) of notification encoded in MIME's base64 in form of Object( language1: 'content1', language2: 'content2' ) OR String
+    #     "en": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9ImF2YWlsYWJsZSIvPg==",
+    #     "de": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48YmFkZ2UgdmFsdWU9Im5ld01lc3NhZ2UiLz4="
+    #  },
+    attribute? :wns_content, Types::Hash
+    # 'Tile' | 'Toast' | 'Badge' | 'Raw'
+    attribute? :wns_type, Types::Strict::String
+    #  optional. Used in Tile replacement policy. An alphanumeric string of no more than 16 characters.
+    attribute? :wns_tag, Types::Strict::String
+    #  optional. (1|0) Translates into X-WNS-Cache-Policy value
+    attribute? :wns_cache, Types::Strict::Integer
+    #  optional. Expiration time for notification in seconds
+    attribute? :wns_ttl, Types::Strict::Integer
+
+    # Safari related
+
+    # obligatory, title of the notification
+    attribute? :safari_title, Types::Strict::String
+
+    # "safari_action": "Click here", // optional
+    attribute? :safari_action, Types::Strict::String
+
+    # "safari_url_args": ["firstArgument", "secondArgument"],
+    # Obligatory, but the value may be empty
+    attribute? :safari_url_args, Types::Strict::Array.of(Types::Strict::String)
+
+    # Optional. Time to live parameter - the maximum lifespan of a message in seconds
+    attribute? :safari_ttl, Types::Strict::Integer.constrained(min_size: 0)
+
+    # Chrome related
+
+    # You can specify the header of the message in this parameter
+    attribute? :chrome_title, Types::Strict::String
+
+    # "chrome_icon":"", full path URL to the icon or extension resources file path
+    attribute? :chrome_icon, Types::Strict::String
+
+    # Time to live parameter - maximum message lifespan in seconds
+    attribute? :chrome_gcm_ttl, Types::Strict::Integer
+
+    # optional, changes chrome push display time.
+    # Set to 0 to display push until user interacts with it
+    attribute? :chrome_duration, Types::Strict::Integer
+
+    # optional, URL to large image.
+    attribute? :chrome_image, Types::Strict::String
+
+    attribute? :chrome_button_text1, Types::Strict::String
+
+    # ignored if chrome_button_text1 is not set
+    attribute? :chrome_button_url1, Types::Strict::String
+
+    attribute? :chrome_button_text2, Types::Strict::String
+
+    # ignored if chrome_button_text2 is not set
+    attribute? :chrome_button_url2, Types::Strict::String
+
+    # Firefox-related
+
+    # optional. You can specify message header here
+    attribute? :firefox_title, Types::Strict::String
+
+    # full path URL to the icon or path to the file in extension resources
+    attribute? :firefox_icon, Types::Strict::String
+
+    def to_json(options = nil)
+      attributes.to_json(options)
+    end
+
+    def inspect
+      attrs = attributes.map { |k, v| " #{k}=#{v.inspect}" }.join
+      "#<#{self.class}#{attrs}>"
+    end
+  end
+end

data/lib/pwush/request.rb

@@ -0,0 +1,22 @@
+module Pwush
+  class Request
+    attr_reader :body
+
+    def initialize(auth:, app:, payload: nil)
+      @auth    = auth
+      @app     = app
+      @payload = payload || {}
+      @body    = build_body(@payload)
+    end
+
+    def to_json
+      Oj.dump(body)
+    end
+
+    private
+
+    def build_body(payload)
+      { request: payload.merge(auth: @auth, application: @app) }
+    end
+  end
+end

data/lib/pwush/response/deffered.rb

@@ -0,0 +1,55 @@
+module Pwush
+  module Response
+    class Deffered
+      include Dry::Monads::Result::Mixin
+
+      def initialize(raw_result)
+        @_raw_result = raw_result
+      end
+
+      def resolve
+        return http_request_failure if raw_result.status != 200
+        return api_request_failure if value_from_api.status_code != 200
+        api_request_succesful
+      end
+
+      private
+
+      def http_request_failure
+        Failure.new(value_from_http)
+      end
+
+      def api_request_failure
+        Failure.new(value_from_api)
+      end
+
+      def api_request_succesful
+        Success.new(value_from_api)
+      end
+
+      def raw_result
+        @_raw_result
+      end
+
+      def parsed_result
+        @_parsed_result ||= raw_result.parse
+      end
+
+      def value_from_http
+        @_value_from_http ||= Value.new(
+          status_code: raw_result.status,
+          status_message: raw_result.reason,
+          body: nil
+        )
+      end
+
+      def value_from_api
+        @_value_from_api ||= Value.new(
+          status_code:    parsed_result['status_code'],
+          status_message: parsed_result['status_message'],
+          body:           parsed_result['response']
+        )
+      end
+    end
+  end
+end

data/lib/pwush/response/value.rb

@@ -0,0 +1,9 @@
+module Pwush
+  module Response
+    class Value < Dry::Struct::Value
+      attribute :status_code, Types::Coercible::Integer
+      attribute? :status_message, Types::Strict::String
+      attribute? :body, (Types::Hash | Types::String).optional
+    end
+  end
+end

data/lib/pwush/response.rb

@@ -0,0 +1,16 @@
+require 'dry/monads/result'
+
+require 'pwush/response/deffered'
+require 'pwush/response/value'
+
+module Pwush
+  module Response
+    include Dry::Monads::Result::Mixin
+
+    def self.wrap
+      Deffered.new(yield).resolve
+    rescue HTTP::TimeoutError => e
+      Failure.new(e)
+    end
+  end
+end

data/lib/pwush/types.rb

@@ -0,0 +1,7 @@
+require 'dry-struct'
+
+module Pwush
+  module Types
+    include Dry.Types()
+  end
+end

data/lib/pwush/version.rb

@@ -0,0 +1,3 @@
+module Pwush
+  VERSION = '0.3.1'.freeze
+end

data/lib/pwush.rb

@@ -0,0 +1,15 @@
+require 'pwush/config'
+
+require 'pwush/types'
+require 'pwush/message'
+
+require 'pwush/response'
+require 'pwush/request'
+
+require 'pwush/client'
+
+module Pwush
+  def self.new(options)
+    Client.new(options)
+  end
+end

data/pwush.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pwush/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'njiuko-pwush'
+  spec.version       = Pwush::VERSION
+  spec.authors       = ['Yaroslav Litvinov', 'Ralph von der Heyden']
+  spec.email         = ['beyondthemkad@gmail.com', 'ralph@rvdh.de']
+
+  spec.summary       = 'Pushwoosh remote API ruby toolkit'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/njiuko/pwush'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.add_dependency 'dry-monads', '~> 1.0'
+  spec.add_dependency 'dry-struct', '~> 1.0'
+  spec.add_dependency 'http', '~> 4.4'
+  spec.add_dependency 'oj', '~> 3'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: njiuko-pwush
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Yaroslav Litvinov
+- Ralph von der Heyden
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Pushwoosh remote API ruby toolkit
+email:
+- beyondthemkad@gmail.com
+- ralph@rvdh.de
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pwush.rb
+- lib/pwush/api/applications.rb
+- lib/pwush/api/devices.rb
+- lib/pwush/api/messages.rb
+- lib/pwush/client.rb
+- lib/pwush/config.rb
+- lib/pwush/message.rb
+- lib/pwush/request.rb
+- lib/pwush/response.rb
+- lib/pwush/response/deffered.rb
+- lib/pwush/response/value.rb
+- lib/pwush/types.rb
+- lib/pwush/version.rb
+- pwush.gemspec
+homepage: https://github.com/njiuko/pwush
+licenses:
+- MIT
+metadata: {}
+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.1.6
+signing_key:
+specification_version: 4
+summary: Pushwoosh remote API ruby toolkit
+test_files: []