firepush 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c8078baed1b8162b2f74d8dc1484f192956eabd0974194b77a6f4820ce43109
+  data.tar.gz: 7f1c6a033890b6fbf0ba01628cdc048b10931a1f8a2a11754ce2db558727fe20
+SHA512:
+  metadata.gz: cd7f586d4e875575024bdf5906906af7f291540ec1f3f813c1bba21630ed40cdb1975f1901b7db21d1ac0ebaea81943f3602b1f260d1684de73410c6cfc7731b
+  data.tar.gz: 2493146182414eedaf77abee51133e2a417964ea67b3649736f7ce1874feaf4251c7b4269f47bcc1ece4ab01bb5d286b1b307afc5074d4ac144acd7537072f13

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+.bundle
+.yardoc
+Gemfile.lock
+_yardoc
+coverage
+doc/
+pkg
+spec/reports/
+tmp
+
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,15 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.1
+  - ruby-head
+before_install: gem install bundler -v 1.17.2
+matrix:
+  allow_failures: ruby-head
+notifications:
+  email: false

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 TODO: Write your email address. 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 firepush.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,74 @@
+# Firepush
+
+[![Build Status](https://travis-ci.org/mmyoji/firepush.svg?branch=master)](https://travis-ci.org/mmyoji/firepush)
+
+Firepush is [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/) client library using [HTTP v1 API](https://firebase.google.com/docs/cloud-messaging/migrate-v1).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'firepush', git: "git://github.com/mmyoji/firepush.git"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as: (This doesn't work now)
+
+    $ gem install firepush
+
+## Usage
+
+You can see the following link to understand the FCM messages.
+
+[About FCM messages | Firebase](https://firebase.google.com/docs/cloud-messaging/concept-options?hl=en)
+
+```rb
+require "firepush"
+
+client = Firepush::Client.new(
+  access_token: "<your Firebase Project Access Token>",
+  project_id:   "<your Firebase project ID>",
+)
+
+# 1. Notification message to a single device
+
+client.push(
+  notification: {
+    title: "Some title is required",
+    body: "Some body is required",
+  },
+  token: "<Android Registration ID>",
+)
+
+# 2. Data message to a topic
+
+client.push(
+  data: {
+    key: "some String value is required",
+    key2: "you can set multiple key-value in this section",
+  },
+  topic: "news",
+)
+```
+
+## 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 tags, 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/mmyoji/firepush. 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 Firepush project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mmyoji/firepush/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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "firepush"
+
+# 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/firepush.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "firepush/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "firepush"
+  spec.version       = Firepush::VERSION
+  spec.authors       = ["mmyoji"]
+  spec.email         = ["mmyoji@gmail.com"]
+
+  spec.summary       = %q{Firebase Cloud Messaging Client library.}
+  spec.description   = %q{Firebase Cloud Messaging Client library which uses HTTP v1 API.}
+  spec.homepage      = "https://github.com/mmyoji/firepush"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/firepush.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Firepush
+  autoload :Client,  "firepush/client"
+  autoload :Message, "firepush/message"
+
+  module MessageType
+    autoload :Base,         "firepush/message_type/base"
+    autoload :Builder,      "firepush/message_type/builder"
+    autoload :Data,         "firepush/message_type/data"
+    autoload :Notification, "firepush/message_type/notification"
+  end
+
+  module Recipient
+    autoload :Base,    "firepush/recipient/base"
+    autoload :Builder, "firepush/recipient/builder"
+    autoload :Token,   "firepush/recipient/token"
+    autoload :Topic,   "firepush/recipient/topic"
+  end
+
+  autoload :HelperMethods, "firepush/helper_methods"
+  autoload :Version,       "firepush/version"
+end

data/lib/firepush/client.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "net/http"
+
+module Firepush
+  class Client
+    class InvalidAttributes < ::StandardError; end
+
+    include HelperMethods
+
+    BASE_URI  = "https://fcm.googleapis.com"
+    BASE_PATH = "/v1/projects"
+
+    attr_accessor :access_token # @return [String]
+    attr_accessor :project_id   # @return [String]
+
+    attr_reader :message # @return [String]
+
+    # @param :access_token [String] optional
+    # @param :project_id   [String] optional
+    def initialize(access_token: "", project_id: "")
+      self.access_token = access_token
+      self.project_id   = project_id
+    end
+
+    # @param message [Hash]
+    def message=(message)
+      @message = Message.new(message)
+    end
+
+    # @param message [Hash] optional
+    #
+    # TODO: Return useful response
+    # @return [Http::Response]
+    #
+    # @raise [Firepush::Client::InvalidAttributes]
+    def push(message = nil)
+      self.message = message unless message.nil?
+
+      raise InvalidAttributes unless valid?
+
+      http.post(path, self.message.to_json, headers)
+    end
+
+    # @return [Boolean]
+    def valid?
+      valid_str?(access_token) && valid_str?(project_id) &&
+        !message.nil? && message.valid?
+    end
+
+    private
+
+    # @private
+    # @return [Hash]
+    def headers
+      {
+        "Content-Type"  => "application/json",
+        "Authorization" => "Bearer #{access_token}",
+      }
+    end
+
+    # @private
+    # @return [Net::HTTP]
+    def http
+      @http ||=
+        begin
+          h = ::Net::HTTP.new(uri.host, uri.port)
+          h.use_ssl = true
+          h
+        end
+    end
+
+    # @private
+    # @return [String]
+    def path
+      "#{BASE_PATH}/#{project_id}/messages:send"
+    end
+
+    # @private
+    # @return [URI::HTTPS]
+    def uri
+      @uri ||= ::URI.parse(BASE_URI)
+    end
+  end
+end

data/lib/firepush/helper_methods.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Firepush
+  module HelperMethods
+    private
+
+    # @private
+    # @param val [String]
+    # @return [Boolean]
+    def valid_str?(val)
+      val.is_a?(::String) && val != ""
+    end
+  end
+end

data/lib/firepush/message.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Firepush
+  class Message
+    attr_reader :recipient    # @return [Firepush::Recipient::Base]
+    attr_reader :message_type # @return [Firepush::MessageType::Base]
+
+    # TODO: handle extra data in better way.
+    attr_reader :extra # @return [Hash]
+
+    # @param  msg [Hash]
+    # @see lib/firepush/{message_type,recipient}/*.rb
+    # @raise [ArgumentError]
+    def initialize(msg)
+      msg = msg.dup
+
+      args = {}
+      args[:topic] = msg.delete(:topic) if msg.key?(:topic)
+      args[:token] = msg.delete(:token) if msg.key?(:token)
+      @recipient = Recipient::Builder.build(args)
+
+      args.clear
+      args[:notification] = msg.delete(:notification) if msg.key?(:notification)
+      args[:data] = msg.delete(:data) if msg.key?(:data)
+      @message_type = MessageType::Builder.build(args)
+
+      @extra = msg
+    end
+
+    # @return [String]
+    def to_json
+      ::JSON.generate(message: message)
+    end
+
+    # @return [Boolean]
+    def valid?
+      recipient.valid? && message_type.valid?
+    end
+
+    private
+
+    # @private
+    # @return [Hash]
+    def message
+      {
+        recipient.key    => recipient.value,
+        message_type.key => message_type.value,
+      }.merge(extra)
+    end
+  end
+end

data/lib/firepush/message_type/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Firepush
+  module MessageType
+    # @abstract
+    class Base
+      include HelperMethods
+
+      # @return [Symbol]
+      def key
+        self.class.name.split("::").last.downcase.intern
+      end
+
+      # @return [Boolean]
+      def valid?
+        raise "#{__method__} is not implemented!"
+      end
+
+      # @return [Hash]
+      def value
+        raise "#{__method__} is not implemented!"
+      end
+    end
+  end
+end

data/lib/firepush/message_type/builder.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Firepush
+  module MessageType
+    class Builder
+      # @param  args [Hash]
+      # @option args [Hash] :notification
+      # @option args [Hash] :data
+      def self.build(args)
+        new(args).build
+      end
+
+      # @private
+      # @see .build
+      def initialize(args)
+        @_args = args
+
+        check_args!
+      end
+      private_class_method :new
+
+      # @return [Firepush::MessageType::Base]
+      def build
+        case
+        when notification?
+          Notification.new(_args.fetch(:notification))
+        when data?
+          Data.new(_args.fetch(:data))
+        end
+      end
+
+      private
+
+      attr_reader :_args
+
+      # @private
+      # @raise [ArgumentError]
+      def check_args!
+        if notification? && data?
+          raise ::ArgumentError.new("Cannot set both :notification and :data")
+        end
+
+        if !notification? && !data?
+          raise ::ArgumentError.new("Must set either :notification or :data")
+        end
+      end
+
+      # @private
+      # @return [Boolean]
+      def data?
+        _args.key?(:data)
+      end
+
+      # @private
+      # @return [Boolean]
+      def notification?
+        _args.key?(:notification)
+      end
+    end
+  end
+end

data/lib/firepush/message_type/data.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Firepush
+  module MessageType
+    class Data < Base
+      attr_reader :data # @return [Hash<Symbol, String>]
+
+      # @param args [Hash]
+      def initialize(args)
+        @data = args
+      end
+
+      # @override
+      # @return [Boolean]
+      def valid?
+        data.is_a?(::Hash) && data.values.all? { |v| v.is_a?(::String) }
+      end
+
+      # @override
+      # @return [Hash]
+      def value
+        data
+      end
+    end
+  end
+end

data/lib/firepush/message_type/notification.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Firepush
+  module MessageType
+    class Notification < Base
+      attr_reader :title # @return [String]
+      attr_reader :body  # @return [String]
+
+      # @param :title [String]
+      # @param :body  [String]
+      def initialize(title:, body:)
+        @title = title
+        @body  = body
+      end
+
+      # @override
+      # @return [Boolean]
+      def valid?
+        valid_str?(title) && valid_str?(body)
+      end
+
+      # @override
+      # @return [Hash]
+      def value
+        { title: title, body: body }
+      end
+    end
+  end
+end

data/lib/firepush/recipient/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Firepush
+  module Recipient
+    # @abstract
+    class Base
+      include HelperMethods
+
+      # @return [Symbol]
+      def key
+        self.class.name.split("::").last.downcase.intern
+      end
+
+      # @return [Boolean]
+      def valid?
+        raise "#{__method__} is not implemented!"
+      end
+
+      # @return [String]
+      def value
+        raise "#{__method__} is not implemented!"
+      end
+    end
+  end
+end

data/lib/firepush/recipient/builder.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Firepush
+  module Recipient
+    class Builder
+      # @param  args [Hash]
+      # @option args [Hash] :topic
+      # @option args [Hash] :token
+      def self.build(args)
+        new(args).build
+      end
+
+      # @private
+      # @see .build
+      def initialize(args)
+        @_args = args
+
+        check_args!
+      end
+      private_class_method :new
+
+      # @return [Firepush::Recipient::Base]
+      def build
+        case
+        when topic?
+          Topic.new(_args.fetch(:topic))
+        when token?
+          Token.new(_args.fetch(:token))
+        end
+      end
+
+      private
+
+      attr_reader :_args
+
+      # @private
+      # @raise [ArgumentError]
+      def check_args!
+        if topic? && token?
+          raise ::ArgumentError.new("Cannot set both :topic and :token")
+        end
+
+        if !topic? && !token?
+          raise ::ArgumentError.new("Must set either :topic or :token")
+        end
+      end
+
+      # @private
+      # @return [Boolean]
+      def token?
+        _args.key?(:token)
+      end
+
+      # @private
+      # @return [Boolean]
+      def topic?
+        _args.key?(:topic)
+      end
+    end
+  end
+end

data/lib/firepush/recipient/token.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Firepush
+  module Recipient
+    class Token < Base
+      attr_reader :token # @return [String]
+
+      # @param token [String] Android Registration ID
+      def initialize(token)
+        @token = token
+      end
+
+      # @override
+      # @return [Boolean]
+      def valid?
+        valid_str?(token)
+      end
+
+      # @override
+      # @return [String]
+      def value
+        token
+      end
+    end
+  end
+end

data/lib/firepush/recipient/topic.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Firepush
+  module Recipient
+    class Topic < Base
+      attr_reader :topic # @return [String]
+
+      # @param topic [String]
+      def initialize(topic)
+        @topic = topic
+      end
+
+      # @override
+      # @return [Boolean]
+      def valid?
+        valid_str?(topic)
+      end
+
+      # @override
+      # @return [String]
+      def value
+        topic
+      end
+    end
+  end
+end

data/lib/firepush/version.rb

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

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: firepush
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- mmyoji
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+description: Firebase Cloud Messaging Client library which uses HTTP v1 API.
+email:
+- mmyoji@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- firepush.gemspec
+- lib/firepush.rb
+- lib/firepush/client.rb
+- lib/firepush/helper_methods.rb
+- lib/firepush/message.rb
+- lib/firepush/message_type/base.rb
+- lib/firepush/message_type/builder.rb
+- lib/firepush/message_type/data.rb
+- lib/firepush/message_type/notification.rb
+- lib/firepush/recipient/base.rb
+- lib/firepush/recipient/builder.rb
+- lib/firepush/recipient/token.rb
+- lib/firepush/recipient/topic.rb
+- lib/firepush/version.rb
+homepage: https://github.com/mmyoji/firepush
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Firebase Cloud Messaging Client library.
+test_files: []