jeapie 0.1.1 → 0.2.0

data/README.md

@@ -6,7 +6,7 @@ It allow send push notification to your Android and Apple devices
 ## Installation
 Add this line to your application's Gemfile:
 
-    $ gem 'jeapie'
+    $ gem 'jeapie', '~> 0.2'
 
 And then execute:
 
@@ -17,6 +17,7 @@ Or install it yourself as:
     $ gem install jeapie
 
 ## Usage
+optional:
 ```ruby
 require 'jeapie'
 ```
@@ -24,25 +25,32 @@ require 'jeapie'
 To send with the very minimum amount of information.
 
 ```ruby
-Jeapie.notify(message: 'message', title: 'title', user: 'USER_TOKEN', token: 'APP_TOKEN')
+# sending to myself
+Jeapie.notify(message: 'message', title: 'title', token: 'APP_TOKEN')
+#sending to all subscribers of your application (providers)
+Jeapie.notify_all(message: 'message', title: 'title', token: 'APP_TOKEN')
+#sending to some subscribers of your application
+Jeapie.notify_multiple(message: 'message', title: 'title', token: 'APP_TOKEN', emails:'user1@mail.com, user2@mail.com')
 ```
 
 Optional you can place in /config/application.rb
 ```ruby
 Jeapie.configure do |config|
-  config.user='USER_TOKEN' # you can take from http://dashboard.jeapie.com
-  config.token='APP_TOKEN'
+  config.token='APP_TOKEN' # you can take from http://dashboard.jeapie.com on section "Providers"
   config.device='Nexus7' #optional
   config.priority=0 #or 1(high) or -1(low, not sound when receive). By default is 0
 end
 
-Jeapie.notify(message: 'message', title: 'title')
-#or just
 Jeapie.notify(message: 'message')
+#or
+Jeapie.notify(message: 'message', title: 'title', priority:Jeapie::PRIORITY_LOW)
 ```
 Method `notify` return true or false. If it return false you can check `Jeapie.errors` for error message.
 Or you can use method `notify!`, it raise exception if something going wrong.
 
+## Migrating from v0.1 to 0.2
+Just delete ``config.token`` from ``/config/application.rb``
+
 ## Contributing
 
 1. Fork it

data/jeapie.gemspec

@@ -22,8 +22,10 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'fakeweb', ['~> 1.3']
 
   # documentation
+  #yardoc --line-numbers --inline-source --title Jeapie --main README.md --encoding=UTF-8
+  #--no-private --protected
   gem.extra_rdoc_files = Dir.glob('*.md')
-  gem.rdoc_options = %w(--line-numbers --inline-source --no-private --protected --title Jeapie --main README.md --encoding=UTF-8)
+  gem.rdoc_options = %w(--line-numbers --inline-source --title Jeapie --main README.md --encoding=UTF-8)
   gem.has_rdoc = 'yard'
 
 end

data/lib/jeapie.rb

@@ -8,12 +8,14 @@ module Jeapie
   class DeliverException < StandardError ; end
   extend self
   # app_token and user_key, you can get it from dashboard.jeapie.com
-  attr_accessor :token, :user
-  attr_accessor :message, :title, :device, :priority
+  attr_accessor :token
+  attr_accessor :message, :title, :device, :priority, :emails
   # After call notify it contain result as {Net::HTTPCreated} object, for check result better see {#errors}
   attr_reader :result
 
-  API_URL= 'https://api.jeapie.com/v1/send/message.json'
+  NOTIFY_API_URL= 'https://api.jeapie.com/v2/personal/send/message.json'
+  NOTIFY_ALL_API_URL= 'https://api.jeapie.com/v2/broadcast/send/message.json'
+  NOTIFY_MULTIPLE_API_URL= 'https://api.jeapie.com/v2/users/send/message.json'
   PRIORITY_LOW=-1
   PRIORITY_MED=0
   PRIORITY_HIGH=1
@@ -24,7 +26,7 @@ module Jeapie
     parameters
   end
 
-  # available parameters and his values
+  # available parameters and its values
   def parameters
     h = {}
     keys.each { |k| h[k.to_sym] = Jeapie.instance_variable_get("@#{k}") }
@@ -32,10 +34,15 @@ module Jeapie
   end
   alias_method :params, :parameters
 
+  # for backward compatibility
+  def user=(val)
+    puts 'DEPRECATED: parameter "Jeapie.user" is obsolete. You can delete it from your config.'
+  end
+
   # List of available fields, useful for unit test.
   # @return Hash
   def keys
-    @keys||= [:token, :user, :message, :title, :device, :priority]
+    @keys||= [:token, :message, :title, :device, :priority]
   end
 
   # Clear stored params, useful for unit tests.
@@ -59,45 +66,87 @@ module Jeapie
     "code: #{result.code}, errors: #{arr['errors']}"
   end
 
-  # Send message to Jeapie.
+  # Send message to one user through Jeapie.
   # example:
   #  notify message:'Backup complete'
   # or:
-  #  notify title:'Backup complete', message:'Time elapsed 50s, size: 500Mb', priority:-1, device:'Nexus7', user:'', token:''
+  #  notify title:'Backup complete', message:'Time elapsed 50s, size: 500Mb', priority:-1, device:'Nexus7', token:''
   #
   # If this method return +false+, you can check {#errors} for text, or you can use {#notify!} for raise +DeliverException+ if any problem
   # @return [true, false]
   def notify(opts={message:''})
-    data = params.merge(opts).select { |_, v| v != nil }
-    return false unless params_errors(data).empty?
-    url = URI.parse(API_URL)
-    req = Net::HTTP::Post.new(url.path, {'User-Agent' => "Ruby jeapie gem: #{Jeapie::VERSION}"})
-    req.set_form_data(data)
+    send_notify(NOTIFY_API_URL, opts)
+  end
 
-    res = Net::HTTP.new(url.host, url.port)
-    res.use_ssl = true
-    res.verify_mode = OpenSSL::SSL::VERIFY_PEER
-    @result= res.start {|http| http.request(req) }
-    errors ? false : true
+  # Send message to all subscribers of application.
+  # example:
+  #  notify_all message:'Backup complete'
+  # or:
+  #  notify_all title:'Backup complete', message:'Time elapsed 50s, size: 500Mb', priority:-1, device:'Nexus7', token:''
+  #
+  # If this method return +false+, you can check {#errors} for text, or you can use {#notify_all!} for raise +DeliverException+ if any problem
+  # @return [true, false]
+  def notify_all(opts={message:''})
+    send_notify(NOTIFY_ALL_API_URL, opts)
+  end
+
+  # Send message to some subscribers of application.
+  # example:
+  #  notify_all message:'Backup complete', emails:['user1@mail.com', 'user3@mail.com']
+  #  notify_all message:'Backup complete', emails:'user1@mail.com, user3@mail.com'
+  #
+  # If this method return +false+, you can check {#errors} for text, or you can use {#notify_multiple!} for raise +DeliverException+ if any problem
+  # @return [true, false]
+  def notify_multiple(opts={message:'', emails:[]})
+    send_notify(NOTIFY_MULTIPLE_API_URL, opts)
   end
 
+  # Similar to {#notify}, but raise +DeliverException+ if any problem
   # @return [true]
   def notify!(opts={message:''})
     raise DeliverException, errors unless notify(opts)
     true
   end
 
+  # Similar to {#notify_all}, but raise +DeliverException+ if any problem
+  # @return [true]
+  def notify_all!(opts={message:''})
+    raise DeliverException, errors unless notify_all(opts)
+    true
+  end
+
+  # Similar to {#notify_multiple}, but raise +DeliverException+ if any problem
+  # @return [true]
+  def notify_multiple!(opts={message:'', emails:[]})
+    raise DeliverException, errors unless notify_multiple(opts)
+    true
+  end
+
   protected
-  def params_errors(params)
+  def params_errors(params, api_url)
     @params_errors=[]
     @params_errors<<'Token cannot be blank' if params[:token].blank?
     @params_errors<<'Token must be 32 symbols' if params[:token].size != 32
-    @params_errors<<'User cannot be blank' if params[:user].blank?
-    @params_errors<<'User must be 32 symbols' if params[:user].size != 32
     @params_errors<<'Message cannot be blank' if params[:message].blank?
+    @params_errors<<'Emails cannot be blank' if params[:emails].blank? && api_url==NOTIFY_MULTIPLE_API_URL
     @params_errors<<"Message too long, max: #{MESSAGE_MAX_LEN}" if params[:message] && params[:message].size > MESSAGE_MAX_LEN
     @params_errors
   end
 
+  def send_notify(api_url, options={})
+    data = params.merge(options).select { |_, v| v != nil }
+    data[:emails]=data[:emails].join(',') if !data[:emails].blank? && data[:emails].is_a?(Array)
+    return false unless params_errors(data, api_url).empty?
+    url = URI.parse(api_url)
+    req = Net::HTTP::Post.new(url.path, {'User-Agent' => "Ruby jeapie gem: #{Jeapie::VERSION}"})
+    req.set_form_data(data)
+
+    res = Net::HTTP.new(url.host, url.port)
+    res.use_ssl = true
+    res.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    @result= res.start {|http| http.request(req) }
+    errors ? false : true
+  end
+
 
 end

data/lib/jeapie/version.rb

@@ -1,3 +1,3 @@
 module Jeapie
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/spec/lib/jeapie_spec.rb

@@ -5,12 +5,10 @@ describe Jeapie do
   before(:each) do
     Jeapie.clear
     Jeapie.configure do |c|
-      c.user='qwqwqwqwqwqwqwqwqwqwqwqwqwqwqwqw'
       c.token='asasasasasasasasasasasasasasasas'
     end
     FakeWeb.clean_registry
   end
-  let(:api_url){Jeapie::API_URL}
   let(:api_ok_answer){'{"success":true,"message":"Message was sent successfully"}'}
   let(:api_fail_answer){'{"success":false,"errors":{"device":["Some error"]}}'}
 
@@ -28,7 +26,7 @@ describe Jeapie do
 
   describe '#parameters' do
     it 'should return all params' do
-      p={token:'1', user:'2', message:'3', title:'4', device:'5', priority:'6'}
+      p={token:'1', message:'3', title:'4', device:'5', priority:'6'}
       p.each do |k,v|
         Jeapie.send "#{k}=", v
       end
@@ -38,7 +36,7 @@ describe Jeapie do
 
   describe '#notify' do
     subject{ Jeapie.notify(params) }
-
+    let(:api_url){Jeapie::NOTIFY_API_URL}
 
     context 'when all params OK' do
       let(:params){ {message:'Text'} }
@@ -78,5 +76,45 @@ describe Jeapie do
     end
   end
 
+  describe '#notify_multiple' do
+    subject{ Jeapie.notify_multiple(params) }
+    let(:api_url){Jeapie::NOTIFY_MULTIPLE_API_URL}
+    before(:each){FakeWeb.register_uri(:post, api_url, :body => api_ok_answer) }
+    context 'when "emails" as array' do
+      let(:params){ {message:'Test message', emails: %w(user1@mail.com user2@mail.com)} }
+      it 'should send "emails" as string' do
+        subject.should be_true
+        FakeWeb.last_request.body.should include CGI.escape('user1@mail.com,user2@mail.com')
+      end
+    end
+    context 'when "emails" as string with spaces' do
+      let(:params){ {message:'Test message', emails: 'user1@mail.com , user2@mail.com'} }
+      it 'should send "emails" as is as' do
+        subject.should be_true
+        FakeWeb.last_request.body.should include CGI.escape('user1@mail.com , user2@mail.com')
+      end
+    end
+    context 'when "emails" is empty' do
+      let(:params){ {message:'Test message', emails: ''} }
+      it 'should return "false" and "errors" must contain info about error' do
+        subject.should be_false
+        Jeapie.errors.should match /Params not valid:/
+        FakeWeb.should_not have_requested(:post, api_url)
+      end
+    end
+  end
+
+  describe '#notify_all' do
+    context 'when all params "OK" and when server return "OK"' do
+      subject{ Jeapie.notify_all(params) }
+      let(:api_url){Jeapie::NOTIFY_ALL_API_URL}
+      let(:params){ {message:'Text'} }
+      before(:each){FakeWeb.register_uri(:post, api_url, :body => api_ok_answer) }
+      it 'should return "true"' do
+        subject.should be_true
+        FakeWeb.should have_requested(:post, api_url)
+      end
+    end
+  end
 
 end

data/whatsnew.md

@@ -1,2 +1,6 @@
+## 0.2
+  * broadcasting (sending notification to all or several subscribers)
+  * use new Jeapie v2 API. v1 no longer supported
+  * param "user" no longer supported, "token" is enough
 ## 0.1.1
   * add YARD documentation

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeapie
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -69,8 +69,6 @@ post_install_message:
 rdoc_options:
 - --line-numbers
 - --inline-source
-- --no-private
-- --protected
 - --title
 - Jeapie
 - --main