firepush 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c8078baed1b8162b2f74d8dc1484f192956eabd0974194b77a6f4820ce43109
-  data.tar.gz: 7f1c6a033890b6fbf0ba01628cdc048b10931a1f8a2a11754ce2db558727fe20
+  metadata.gz: e7d7d6a2b469b0123ac7bafea8198f40b8a739548d45ab4940ebbc16f8316170
+  data.tar.gz: b9d2d7d2998108930f1f120747486e8ee057adf2213b91a7f4e8ea2557248c66
 SHA512:
-  metadata.gz: cd7f586d4e875575024bdf5906906af7f291540ec1f3f813c1bba21630ed40cdb1975f1901b7db21d1ac0ebaea81943f3602b1f260d1684de73410c6cfc7731b
-  data.tar.gz: 2493146182414eedaf77abee51133e2a417964ea67b3649736f7ce1874feaf4251c7b4269f47bcc1ece4ab01bb5d286b1b307afc5074d4ac144acd7537072f13
+  metadata.gz: 6549b9cb0afb7b808dcbda164c5f257cae152af884cc94501280b39b31e3bacdcfd7edaf92530aa0edcaf1f52e1a0627e5aa55a18014c46da90304c8824710b8
+  data.tar.gz: 37e9c3654f5dce4b50cb02f2de10589225eb7bc768d61985c23c5d2ae05ab9357c78062623832b70f3bbeca3bceebd27840a0568eb23f6c275e56302f07eaa98

data/.dockerignore

@@ -0,0 +1,6 @@
+.git
+.rspec_status
+
+CODE_OF_CONDUCT.md
+Dockerfile
+README.md

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Layout:
+  Enabled: false
+Metrics:
+  Enabled: false
+Rails:
+  Enabled: false
+Style:
+  Enabled: false

data/.travis.yml

@@ -7,9 +7,9 @@ rvm:
   - 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
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
 notifications:
   email: false

data/Dockerfile

@@ -0,0 +1,17 @@
+FROM ruby:2.6.1-alpine
+
+RUN apk add \
+  gcc \
+  git \
+  libc-dev \
+  make
+
+WORKDIR /app
+
+COPY firepush.gemspec         /app/firepush.gemspec
+COPY Gemfile                  /app/Gemfile
+COPY lib/firepush/version.rb  /app/lib/firepush/version.rb
+
+RUN bundle install
+
+COPY . /app

data/README.md

@@ -9,14 +9,14 @@ Firepush is [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-me
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'firepush', git: "git://github.com/mmyoji/firepush.git"
+gem 'firepush'
 ```
 
 And then execute:
 
     $ bundle install
 
-Or install it yourself as: (This doesn't work now)
+Or install it yourself as:
 
     $ gem install firepush
 
@@ -35,24 +35,45 @@ client = Firepush::Client.new(
 )
 
 # 1. Notification message to a single device
-
 client.push(
   notification: {
-    title: "Some title is required",
-    body: "Some body is required",
+    title: "Hello",
+    body:  "from firepush!",
   },
-  token: "<Android Registration ID>",
+  token: "<client token>",
 )
 
 # 2. Data message to a topic
+client.push(
+  data: {
+    key:  "foo",
+    key2: "bar",
+  },
+  topic: "news",
+)
 
+# 3. You can set both Notification/Data message types
 client.push(
+  notification: {
+    title: "Hello",
+    body:  "from firepush!",
+  },
   data: {
-    key: "some String value is required",
-    key2: "you can set multiple key-value in this section",
+    key:  "foo",
+    key2: "bar",
   },
   topic: "news",
 )
+
+# or you can set message beforehand.
+client.message = {
+  notification: {
+    title: "hey"
+    body:  "siri",
+  },
+  topic: "apple",
+}
+client.push
 ```
 
 ## Development

data/firepush.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.64"
 end

data/lib/firepush.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Firepush
-  autoload :Client,  "firepush/client"
-  autoload :Message, "firepush/message"
+  autoload :Client,       "firepush/client"
+  autoload :Message,      "firepush/message"
+  autoload :MessageTypes, "firepush/message_types"
 
   module MessageType
     autoload :Base,         "firepush/message_type/base"
@@ -12,10 +13,11 @@ module Firepush
   end
 
   module Recipient
-    autoload :Base,    "firepush/recipient/base"
-    autoload :Builder, "firepush/recipient/builder"
-    autoload :Token,   "firepush/recipient/token"
-    autoload :Topic,   "firepush/recipient/topic"
+    autoload :Base,      "firepush/recipient/base"
+    autoload :Builder,   "firepush/recipient/builder"
+    autoload :Condition, "firepush/recipient/condition"
+    autoload :Token,     "firepush/recipient/token"
+    autoload :Topic,     "firepush/recipient/topic"
   end
 
   autoload :HelperMethods, "firepush/helper_methods"

data/lib/firepush/client.rb

@@ -31,7 +31,7 @@ module Firepush
     # @param message [Hash] optional
     #
     # TODO: Return useful response
-    # @return [Http::Response]
+    # @return [Net::HTTPResponse]
     #
     # @raise [Firepush::Client::InvalidAttributes]
     def push(message = nil)

data/lib/firepush/message.rb

@@ -4,27 +4,29 @@ require "json"
 
 module Firepush
   class Message
-    attr_reader :recipient    # @return [Firepush::Recipient::Base]
-    attr_reader :message_type # @return [Firepush::MessageType::Base]
+    attr_reader :recipient     # @return [Firepush::Recipient::Base]
+    attr_reader :message_types # @return [Firepush::MessageTypes]
 
     # TODO: handle extra data in better way.
     attr_reader :extra # @return [Hash]
 
     # @param  msg [Hash]
-    # @see lib/firepush/{message_type,recipient}/*.rb
+    # @see lib/firepush/{recipient/*,message_types}.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::TYPES.each do |type|
+        args[type] = msg.delete(type) if msg.key?(type)
+      end
       @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)
+      MessageType::TYPES.each do |type|
+        args[type] = msg.delete(type) if msg.key?(type)
+      end
+      @message_types = MessageTypes.new(args)
 
       @extra = msg
     end
@@ -36,7 +38,7 @@ module Firepush
 
     # @return [Boolean]
     def valid?
-      recipient.valid? && message_type.valid?
+      recipient.valid? && message_types.valid?
     end
 
     private
@@ -44,10 +46,9 @@ module Firepush
     # @private
     # @return [Hash]
     def message
-      {
-        recipient.key    => recipient.value,
-        message_type.key => message_type.value,
-      }.merge(extra)
+      message_types.message.merge({
+        recipient.key => recipient.value
+      }.merge(extra))
     end
   end
 end

data/lib/firepush/message_type/builder.rb

@@ -2,6 +2,9 @@
 
 module Firepush
   module MessageType
+    # TODO: support :android, :webpush and :apns
+    TYPES = %i(notification data)
+
     class Builder
       # @param  args [Hash]
       # @option args [Hash] :notification
@@ -14,8 +17,6 @@ module Firepush
       # @see .build
       def initialize(args)
         @_args = args
-
-        check_args!
       end
       private_class_method :new
 
@@ -33,18 +34,6 @@ module Firepush
 
       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?

data/lib/firepush/message_types.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Firepush
+  class MessageTypes
+    attr_reader :types # @return [Array<Firepush::MessageType::Base>]
+
+    # @param  args [Hash]
+    # @option args [Hash] :notification
+    # @option args [Hash] :data
+    def initialize(args)
+      valid_types = MessageType::TYPES.reduce([]) do |acc, type|
+        acc.push(type => args[type]) if args.key?(type)
+        acc
+      end
+
+      @types = valid_types.map { |type| MessageType::Builder.build(type) }
+    end
+
+    # @return [Hash]
+    def message
+      types.reduce({}) do |acc, type|
+        acc[type.key] = type.value
+        acc
+      end
+    end
+
+    # @return [Boolean]
+    def valid?
+      types.count > 0 && types.all?(&:valid?)
+    end
+  end
+end

data/lib/firepush/recipient/builder.rb

@@ -2,10 +2,13 @@
 
 module Firepush
   module Recipient
+    TYPES = %i(topic token condition)
+
     class Builder
       # @param  args [Hash]
       # @option args [Hash] :topic
       # @option args [Hash] :token
+      # @option args [Hash] :condition
       def self.build(args)
         new(args).build
       end
@@ -26,6 +29,8 @@ module Firepush
           Topic.new(_args.fetch(:topic))
         when token?
           Token.new(_args.fetch(:token))
+        when condition?
+          Condition.new(_args.fetch(:condition))
         end
       end
 
@@ -36,13 +41,19 @@ module Firepush
       # @private
       # @raise [ArgumentError]
       def check_args!
-        if topic? && token?
-          raise ::ArgumentError.new("Cannot set both :topic and :token")
+        count = TYPES.reduce(0) do |sum, type|
+          sum += 1 if _args.key?(type)
+          sum
         end
+        return if count == 1
 
-        if !topic? && !token?
-          raise ::ArgumentError.new("Must set either :topic or :token")
-        end
+        raise ::ArgumentError.new("Have to set one of :topic, :token, or :condition")
+      end
+
+      # @private
+      # @return [Boolean]
+      def condition?
+        _args.key?(:condition)
       end
 
       # @private

data/lib/firepush/recipient/condition.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Firepush
+  module Recipient
+    class Condition < Base
+      attr_reader :condition # @return [String]
+
+      # @param condition [String]
+      def initialize(condition)
+        @condition = condition
+      end
+
+      # @override
+      # @return [Boolean]
+      # @see https://firebase.google.com/docs/cloud-messaging/send-message?hl=en
+      # @note Doesn't add parser for the condition string because it can be mess
+      def valid?
+        valid_str?(condition)
+      end
+
+      # @override
+      # @return [String]
+      def value
+        condition
+      end
+    end
+  end
+end

data/lib/firepush/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firepush
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - mmyoji
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2019-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.64'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.64'
 description: Firebase Cloud Messaging Client library which uses HTTP v1 API.
 email:
 - mmyoji@gmail.com
@@ -59,10 +73,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -78,8 +95,10 @@ files:
 - lib/firepush/message_type/builder.rb
 - lib/firepush/message_type/data.rb
 - lib/firepush/message_type/notification.rb
+- lib/firepush/message_types.rb
 - lib/firepush/recipient/base.rb
 - lib/firepush/recipient/builder.rb
+- lib/firepush/recipient/condition.rb
 - lib/firepush/recipient/token.rb
 - lib/firepush/recipient/topic.rb
 - lib/firepush/version.rb