push_woosher 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in push_woosher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Thomas Riboulet
+
+MIT License
+
+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,147 @@
+# PushWoosher
+
+Push Woosher is a simple wrapper for Push Woosh. While there is already other
+ones this ome is aimed to be simple, allow register, unregister devices and
+send push notifications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'push_woosher'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install push_woosher
+
+## Usage
+
+You need to configure your access :
+
+```
+PushWoosher.configure do |config|
+  config.application_code = 'APPP-IDDD'
+  config.api_token = 'the-api-token'
+end
+```
+
+### Devices handling
+
+This gem for now supports only 2 types of devices : Ios and Android.
+
+You need 2 identifiers for each device : the usual token and a hardware token.
+
+#### iOS
+
+To register an iOS device you need to use the following :
+
+```
+  device = PushWoosher::Device::Ios.new(
+             token: token,
+             hwid: some_other_id
+           )
+  device.register
+```
+
+That method will return either true or a hash with the status code and response
+body.
+
+To unregister you need to use the following :
+
+```
+  device.unregister
+```
+
+#### Android
+
+To register an Android device you need to use the following :
+
+```
+  device = PushWoosher::Device::Android.new(
+             token: token,
+             hwid: some_other_id
+           )
+  device.register
+```
+
+That method will return either true or a hash with the status code and response
+body.
+
+To unregister you need to use the following :
+
+```
+  device.unregister
+```
+
+### Push Messages
+
+Sending a push message to a device requires the token and the notification hash.
+
+Depending on the device type you need to use one of the following format :
+
+```
+# iOS
+{
+  send_date: 'now',
+  ignore_user_timezone: true,
+  content: 'PUSH MESSAGE',
+  data: {
+    user_id: 1,
+    notification_type: 2
+  },
+  platforms: [1],
+  ios_root_params: {
+    aps: { content-available: 1 }
+  },
+  devices: ['device-token']
+}
+
+# Android
+{
+  send_date: 'now',
+  ignore_user_timezone: true,
+  content: 'PUSH MESSAGE',
+  data: {
+    user_id: 1,
+    notification_type: 2
+  },
+  platforms: [3],
+  android_root_params: {
+    { bob: 1 }
+  },
+  devices: ['device-token']
+}
+```
+
+Notice that most of then content is similar, only the *ios_root_params*, *android_root_params* and *platforms* keys are different.
+
+To allow finer control on the content the input will stay that way, we suggest you to use a formatter class in your app to simplify things for your needs.
+
+Sending a push notification itself can be done as follow :
+
+```
+notification = {} # use the format seen previously
+
+push = PushWoosher::new(notification: notification)
+
+push.post
+```
+
+PushWoosh shows the push history easily in their web panel.
+
+## Requirements
+
+This gems uses Virtus to make things easier internally. There is no dependency on ActiveSupport.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/push_woosher/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/push_woosher.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'virtus'
+require 'json'
+require 'bundler'
+require 'faraday'
+require 'securerandom'
+
+Bundler.setup(:default)
+
+require 'push_woosher/version'
+require 'push_woosher/base'
+require 'push_woosher/config'
+require 'push_woosher/push'
+require 'push_woosher/device/base'
+require 'push_woosher/device/android'
+require 'push_woosher/device/ios'
+
+module PushWoosher
+  # Your code goes here...
+end

data/lib/push_woosher/base.rb

@@ -0,0 +1,39 @@
+module PushWoosher
+  class Base
+    include Virtus.model
+
+    BASE_HOST = 'cp.pushwoosh.com'
+    PROTOCOL = 'https'
+    BASE_PATH = '/json/1.3'
+
+    def connection
+      @connection = Faraday.new(url: "#{PROTOCOL}://#{BASE_HOST}") do |faraday|
+        faraday.request :url_encoded             # form-encode POST params
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    def post_action(opts = {})
+      response = connection.post do |req|
+        req.url "#{BASE_PATH}/#{opts[:path]}"
+        req.headers['Content-Type'] = 'application/json'
+        req.body = { request: opts[:request_hash].merge(config) }.to_json
+      end
+
+      case response.status
+      when 200
+        true
+      else
+        { status: response.status, message: response.body }
+      end
+    end
+
+    def config
+      {
+        application: PushWoosher.configuration.application_code,
+        auth: PushWoosher.configuration.api_token
+      }
+    end
+  end
+end

data/lib/push_woosher/config.rb

@@ -0,0 +1,19 @@
+module PushWoosher
+  class Config
+    attr_accessor :application_code
+    attr_accessor :api_token
+
+    def setup
+      yield self
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Config.new
+      yield(configuration)
+    end
+  end
+end

data/lib/push_woosher/device/android.rb

@@ -0,0 +1,9 @@
+module PushWoosher
+  module Device
+    class Android < PushWoosher::Device::Base
+      def device_type
+        3
+      end
+    end
+  end
+end

data/lib/push_woosher/device/base.rb

@@ -0,0 +1,41 @@
+module PushWoosher
+  module Device
+    class Base < PushWoosher::Base
+      attribute :token
+      attribute :hwid
+
+      def device_type
+        raise NotImplementedError
+      end
+
+      def register_request_hash
+        {
+          push_token: token,
+          hwid: hwid,
+          timezone: 0,
+          device_type: device_type
+        }
+      end
+
+      def unregister_request_hash
+        {
+          hwid: hwid
+        }
+      end
+
+      def register
+        post_action(
+          path: 'registerDevice',
+          request_hash: register_request_hash
+        )
+      end
+
+      def unregister
+        post_action(
+          path: 'unregisterDevice',
+          request_hash: unregister_request_hash
+        )
+      end
+    end
+  end
+end

data/lib/push_woosher/device/ios.rb

@@ -0,0 +1,9 @@
+module PushWoosher
+  module Device
+    class Ios < PushWoosher::Device::Base
+      def device_type
+        1
+      end
+    end
+  end
+end

data/lib/push_woosher/push.rb

@@ -0,0 +1,22 @@
+module PushWoosher
+  class Push < PushWoosher::Base
+    attribute :notification
+
+    def resource_path
+      'createMessage'
+    end
+
+    def request_hash
+      {
+        notifications: [notification]
+      }
+    end
+
+    def post
+      post_action(
+        path: resource_path,
+        request_hash: request_hash
+      )
+    end
+  end
+end

data/lib/push_woosher/version.rb

@@ -0,0 +1,3 @@
+module PushWoosher
+  VERSION = "0.0.1"
+end

data/push_woosher.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'push_woosher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "push_woosher"
+  spec.version       = PushWoosher::VERSION
+  spec.authors       = ["Thomas Riboulet"]
+  spec.email         = ["riboulet@gmail.com"]
+  spec.summary       = %q{A simple wrapper for Push Woosh.}
+  spec.description   = %q{A simple wrapper for Push Woosh.}
+  spec.homepage      = "https://github.com/mcansky/push_woosher"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'ffaker'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.0.1'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'virtus'
+end

data/spec/lib/base_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe PushWoosher::Base do
+  describe 'constants' do
+    it 'should have the base host' do
+      expect(PushWoosher::Base::BASE_HOST).to eq 'cp.pushwoosh.com'
+    end
+    it 'should have the protocol' do
+      expect(PushWoosher::Base::PROTOCOL).to eq 'https'
+    end
+    it 'should have the base host' do
+      expect(PushWoosher::Base::BASE_PATH).to eq '/json/1.3'
+    end
+  end
+
+  describe '#config' do
+    let(:configuration) { double(application_code: 'aa', api_token: 'bb') }
+    let(:expected_hash) { { application: 'aa', auth: 'bb' } }
+    before do
+      allow(PushWoosher).to receive(:configuration).and_return(configuration)
+    end
+    its(:config) { should eq expected_hash }
+  end
+
+  describe '#post_action' do
+    let(:connection) { double(post: response) }
+    before do
+      allow(subject).to receive(:connection).and_return(connection)
+    end
+
+    context 'success' do
+      let(:response) { double(status: 200) }
+      its(:post_action) { should eq true }
+    end
+
+    context 'failure' do
+      let(:response_hash) { { status: 404, message: 'something is wrong' } }
+      let(:response) { double(status: 404, body: 'something is wrong') }
+      its(:post_action) { should eq response_hash }
+    end
+  end
+end

data/spec/lib/device/android_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe PushWoosher::Device::Android do
+  its(:device_type) { should eq 3 }
+end

data/spec/lib/device/base_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe PushWoosher::Device::Base do
+  let(:token) { SecureRandom.hex }
+  let(:hwid) { SecureRandom.hex }
+  let(:options) { { token: token, hwid: hwid } }
+
+  subject { described_class.new(options) }
+
+  it { should respond_to(:token) }
+  it { should respond_to(:hwid) }
+  it { should respond_to(:device_type) }
+
+  context 'requests hashes' do
+    let(:device_type) { 1 }
+
+    before { allow(subject).to receive(:device_type).and_return(device_type) }
+
+    describe '#register_request_hash' do
+      let(:register_hash) do
+        {
+          push_token: token,
+          hwid: hwid,
+          timezone: 0,
+          device_type: device_type
+        }
+      end
+
+      its(:register_request_hash) { should eq register_hash }
+    end
+
+    describe '#unregister_request_hash' do
+      let(:unregister_hash) { { hwid: hwid } }
+      its(:unregister_request_hash) { should eq unregister_hash }
+    end
+  end
+end

data/spec/lib/device/ios_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe PushWoosher::Device::Ios do
+  its(:device_type) { should eq 1 }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'push_woosher'
+require 'rspec/its'
+require 'ffaker'
+
+
+RSpec.configure do |config|
+  config.color = true
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: push_woosher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Riboulet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple wrapper for Push Woosh.
+email:
+- riboulet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/push_woosher.rb
+- lib/push_woosher/.DS_Store
+- lib/push_woosher/base.rb
+- lib/push_woosher/config.rb
+- lib/push_woosher/device/android.rb
+- lib/push_woosher/device/base.rb
+- lib/push_woosher/device/ios.rb
+- lib/push_woosher/push.rb
+- lib/push_woosher/version.rb
+- push_woosher.gemspec
+- spec/lib/base_spec.rb
+- spec/lib/device/android_spec.rb
+- spec/lib/device/base_spec.rb
+- spec/lib/device/ios_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mcansky/push_woosher
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1342462332260062096
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1342462332260062096
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple wrapper for Push Woosh.
+test_files:
+- spec/lib/base_spec.rb
+- spec/lib/device/android_spec.rb
+- spec/lib/device/base_spec.rb
+- spec/lib/device/ios_spec.rb
+- spec/spec_helper.rb