j7w1 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1aa16f84153486f2d40ab5806b51656e35e914e9
+  data.tar.gz: 3c26a01d9f6eaa343592709edfeb35b3c5a0c469
+SHA512:
+  metadata.gz: de214ef7b05d91fc18494403906ce3b0653bbb33c0ce88b6292795199a41df99a33a8cb2535e1171fa7bdcf9a0b7cf3ca5908d10ef5721fff6c292ea70f315c2
+  data.tar.gz: ddea72235386072cf3642b577865146f101c60133df8467e95d6da633ae9cab94e819e0646596b22355b6118c246df472b8190109fe424644a576f83ae93193b

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 condor
+
+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,84 @@
+# J7W1
+
+A gem to send the push notification to mobile app via Amazon Simple Notification Service (SNS). Currently supports only iOS platform, but the support for Android is also scheduled.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'j7w1'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install j7w1
+
+## Usage
+
+First, configure your app.
+
+    J7W1.configure 'config.yml'
+
+Or, you may configure programatically as below:
+
+    configuration = {
+        app_endpoint: {
+            ios: {arn: ...},
+        },
+        account: {
+            ...
+        }
+    }
+    J7W1.configure 
+
+Configuration is expected to have the structure as below:
+
+    app_endpoint:
+        ios:
+            arn: "<The ARN of your app.>"
+    account:
+        access_key_id: "<Your Access Key>"
+        secret_access_key: "<Your Secret Key>"
+        region: '<Your Region>'
+
+
+If you use this with RoR, top-level environmental definition can be available.
+
+### Registering device to SNS
+
+J7W1::PushClient.create_device_endpoint.
+
+    J7W1::PushClient.create_device_identifier device_identifier, platform
+
+This method returns the arn registered.
+
+### Sending push
+
+J7W1::PushClient.push.
+
+    J7W1::PushClient.push endpoint_arn, platform, message: some_message, badge: badge_count, sound: xxx
+
+endpoint_arn should be the return value of the :create_device_endpoint above.
+
+## RoR Integration
+
+The generator j7w1:model must be useful for you. It provides the items below:
+
+1. The model J7W1ApplicationDevice. This model enables you to store the device information and to push easily.
+2. The migration for the model above.
+3. Asyncronous SNS Syncing support. Currently delayed_job and sidekiq are supported. If you use this feature, invoke j7w1:model generation with --async-engine=(delayed_job|sidekiq).
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## Author
+
+TOYODA Naoto https://github.com/condor

data/Rakefile

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

data/j7w1.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'j7_w1/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "j7w1"
+  spec.version       = J7W1::VERSION
+  spec.authors       = ["condor"]
+  spec.email         = ["condor1226@gmail.com"]
+  spec.description   = %q{Mobile apps push client}
+  spec.summary       = %q{Mobile apps push client}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "aws-sdk", "~> 1.17"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/generators/j7_w1/migration/migration_generator.rb

@@ -0,0 +1,38 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module J7W1
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        migration_number += 1
+        migration_number.to_s
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    desc "This generator provides the tables which the J7W1 uses."
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/j7w1_application_devices'
+      end
+    end
+    
+  end
+end

data/lib/generators/j7_w1/migration/templates/active_record/migration.rb

@@ -0,0 +1,11 @@
+class J7W1ApplicationDevices < ActiveRecord::Migration
+  def change
+    create_table :j7w1_application_devices do |t|
+      t.string  :owner_type,          null: false
+      t.integer :owner_id,            null: false
+      t.string  :device_identifier,   null: false
+      t.string  :platform,            null: false
+      t.string  :device_endpoint_arn, null: true
+    end
+  end
+end

data/lib/generators/j7_w1/model/model_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+
+module J7W1
+  class ModelGenerator < Rails::Generators::Base
+    source_root File.join(File.dirname(__FILE__), 'templates')
+    class_option :async_engine, type: :string, default: nil,
+      desc: 'AWS register/deregister processing method'
+
+    def create_model_file
+      template "j7_w1_application_device.rb.erb",
+        "app/models/j7_w1_application_device.rb"
+
+      if options['async_engine'] == 'sidekiq'
+        copy_file "j7_w1_create_endpoint_worker.rb",
+          "app/workers/j7_w1_create_endpoint_worker.rb"
+        copy_file "j7_w1_destroy_endpoint_worker.rb",
+          "app/workers/j7_w1_destroy_endpoint_worker.rb"
+      end
+
+      invoke "j7_w1:migration"
+    end
+  end
+end

data/lib/generators/j7_w1/model/templates/j7_w1_application_device.rb.erb

@@ -0,0 +1,48 @@
+class J7W1ApplicationDevice < ActiveRecord::Base
+  set_table_name 'j7w1_application_devices'
+
+  belongs_to :owner, polymorphic: true
+
+<%- if options['async_engine'] -%>
+  after_create :create_device_endpoint_async
+  after_destroy :destroy_device_endpoint_async
+<%- else -%>
+  after_create :create_device_endpoint
+  after_destroy :destroy_device_endpoint
+<%- end -%>
+
+  def push!(options = {})
+    J7W1::PushClient.push device_endpoint_arn, platform, *options
+  end
+
+  def create_device_endpoint
+    device_endpoint_arn = J7W1::PushClient.create_device_endpoint device_identifier, platform_id,
+      custom_user_data: "#{owner.class} ##{owner.id}"
+    update_attributes! device_endpoint_arn: device_endpoint_arn
+  end
+
+  def destroy_device_endpoint
+    J7W1::PushClient.destroy_endpoint device_arn
+  end
+<%- if options['async_engine'] == 'delayed_job' -%>
+
+  private
+  def create_device_endpoint_async
+    delay.create_device_endpoint
+  end
+
+  def destroy_device_endpoint_async
+    delay.destroy_device_endpoint
+  end
+<%- elsif options['async_engine'] == 'sidekiq' -%>
+
+  private
+  def create_device_endpoint_async
+    J7W1Worker.perform_async id
+  end
+
+  def destroy_device_endpoint_async
+    J7W1Worker.perform_async id
+  end
+<%- end -%>
+end

data/lib/generators/j7_w1/model/templates/j7_w1_create_endpoint_worker.rb

@@ -0,0 +1,7 @@
+class J7W1CreateEndpointWorker
+  include Sidekiq::Worker
+
+  def perform(id)
+    J7W1ApplicationDevice.find(id).create_device_endpoint
+  end
+end

data/lib/generators/j7_w1/model/templates/j7_w1_destroy_endpoint_worker.rb

@@ -0,0 +1,7 @@
+class J7W1DestroyEndpointWorker
+  include Sidekiq::Worker
+
+  def perform(id)
+    J7W1ApplicationDevice.find(id).destroy_device_endpoint
+  end
+end

data/lib/j7_w1/active_record_ext.rb

@@ -0,0 +1,38 @@
+module J7W1
+  module ActiveRecordExt
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      private
+      def application_device_owner
+        include InstanceMethods
+
+        has_many :application_devices, class_name: 'J7W1::ApplicationDevice'
+      end
+    end
+
+    module InstanceMethods
+      def add_device(device_identifier, platform)
+        device =
+          devices.where(device_identifier: device_identifier, platform: platform).
+          find_or_initialize
+        device.endpoint_arn = nil
+        device.save!
+      end
+
+      def remove_device(device_identifier, platform)
+        devices.where(device_identifier: device_identifier, platform: platform).
+          destroy_all
+      end
+
+      def push!(options = {})
+        sns_client = self.create_sns_client
+        aplication_devices.each do |device|
+          device.push! options.tap{|o|o.merge! sns_client: sns_client}
+        end
+      end
+    end
+  end
+end

data/lib/j7_w1/concrete.rb

@@ -0,0 +1,2 @@
+require 'j7_w1/push_client'
+require 'j7_w1/active_record_ext' if Object.const_defined? :ActiveRecord

data/lib/j7_w1/configuration.rb

@@ -0,0 +1,52 @@
+module J7W1
+  class Configuration
+    module IOSEndpoint
+      def sandbox?
+        @sandbox
+      end
+
+      def arn
+        self[:arn]
+      end
+
+      def confirm_sandbox
+        arn =~ /:app\/APNS_SANDBOX\//
+      end
+    end
+
+    module AndroidEndpoint
+      def arn
+        self[:arn]
+      end
+    end 
+
+    module Account
+      [:access_key_id, :secret_access_key, :region].each do |attr|
+        define_method(attr){self[attr]}
+      end
+    end
+
+    def initialize(configuration_values)
+      @values = configuration_values
+      if ios_endpoint
+        ios_endpoint.extend(IOSEndpoint)
+        ios_endpoint.confirm_sandbox
+      end
+      android_endpoint.extend(AndroidEndpoint) if android_endpoint
+      account.extend(Account)
+    end
+
+    def account
+      @values[:account]
+    end
+
+    def ios_endpoint
+      @values[:app_endpoint][:ios]
+    end
+
+    def android_endpoint
+      #TODO configの対応
+      @values[:app_endpoint][:android]
+    end
+  end
+end

data/lib/j7_w1/push_client.rb

@@ -0,0 +1,83 @@
+module J7W1
+  module PushClient
+    def create_sns_client(configuration = J7W1.configuration)
+      AWS::SNS.new J7W1.configuration.account
+    end
+
+    def create_device_endpoint(device_identifier, platform, options = {})
+      custom_user_data = options[:custom_user_data]
+      sns_configuration = options[:sns_configuration]
+      sns_client = options[:sns_client]
+
+      sns_client ||= create_sns_client(sns_configuration || J7W1.configuration)
+
+      sns_config = J7W1.configuration
+      app_arn = platform == :ios ?  sns_config.ios_endpoint.arn :
+        sns_config.android_endpoint.arn
+
+      endpoint =
+        sns_client.client.create_platform_endpoint(
+          platform_application_arn: app_arn,
+          token: device_identifier,
+          custom_user_data: custom_user_data
+        )
+      endpoint[:endpoint_arn]
+    end
+
+    def destroy_endpoint(device_endpoint_arn, options = {})
+      sns_client = options[:sns_client]
+      sns_client ||= create_sns_client(sns_configuration || J7W1.configuration)
+
+      sns_client.client.delete_endpoint(endpoint_arn: device_endpoint_arn)
+    rescue
+      nil
+    end
+
+    def push(endpoint_arn, platform, options = {})
+      return unless endpoint_arn && platform
+
+      message = options[:message]
+      badge = options[:badge]
+      sound = options[:sound]
+      sns_configuration = options[:sns_configuration]
+      sns_client = options[:sns_client]
+
+      message_value = {}
+      message_value.merge!(alert: message) unless message.blank?
+      message_value.merge!(badge: badge) unless badge.blank?
+      message_value.merge!(sound: sound) unless sound.blank?
+
+      payload = payload_for(message_value, platform)
+
+      sns_client ||= create_sns_client(sns_configuration || J7W1.configuration)
+      sns_client.client.publish(
+          target_arn: endpoint_arn,
+          message: payload.to_json,
+          message_structure: 'json',
+      )
+    end
+
+    private
+    def payload_for(message_value, platform)
+      case platform
+        when 'ios'
+          ios_payload_for(message_value)
+        when 'android'
+          android_payload_for(message_value)
+      end
+    end
+
+    def ios_payload_for(message_value)
+      prefix = J7W1::Sns.configuration.ios_endpoint.sandbox? ?
+          :APNS_SANDBOX : :APNS
+      {prefix => {aps: message_value}.to_json}
+    end
+
+    def android_payload_for(message_value)
+      # TODO Android Push Implementation
+    end
+
+    module_function :create_sns_client, :create_device_endpoint, :push,
+      :payload_for, :ios_payload_for, :android_payload_for
+  end
+end

data/lib/j7_w1/stub.rb

@@ -0,0 +1,47 @@
+module J7W1
+  module PushClient
+
+    class << self
+      def push_histories
+        @push_histories ||= []
+      end
+
+      def push(device, options)
+        @push_histories.push(options.merge(device: device))
+      end
+    end
+  end
+
+  module ActiveRecordExt
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def device_owner_classes
+        require 'set'
+        @device_owner_classes ||= Set.new
+      end
+
+      private
+      def device_owner
+        device_owner_classes << self
+      end
+    end
+
+    module InstanceMethods
+      def push!(options = {})
+        sns_client = self.create_sns_client
+        aplication_devices.each do |device|
+          device.push! sns_client, *options
+        end
+      end
+
+      def add_device(device_identifier, platform)
+      end
+
+      def remove_device(device_identifier, platform)
+      end
+    end
+  end
+end

data/lib/j7_w1/version.rb

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

data/lib/j7w1.rb

@@ -0,0 +1,88 @@
+require 'yaml'
+
+module J7W1
+  autoload :Configuration, 'j7_w1/configuration'
+
+  class << self
+    attr_reader :current_strategy
+    private :current_strategy
+
+    def configure(configuration)
+      raise ArgumentError,
+        "J7W1 configuration values should be an instance of Hash or String, but actually it is a kind of #{configuration.class.name}" unless
+      configuration.is_a?(Hash) || configuration.is_a?(String)
+
+      configuration = configuration_values_of(configuration)
+      if configuration[:mock]
+        require 'j7_w1/mock'
+        return
+      end
+
+      require 'j7_w1/concrete'
+      @configuration = Configuration.new configuration
+    end
+
+    def configuration
+      @configuration
+    end
+
+    private
+    def configuration_values_of(configuration)
+      configuration = 
+        case configuration
+          when String
+            configuration_values_of(YAML.load(File.read(configuration)))
+          when Hash
+            configuration
+          else
+            raise ArgumentError, "J7W1.configure can acceptable only Hash(configuration values) or String(pointing the yaml config file)"
+          end
+      configuration = symbolize_keys_recursive(configuration)
+
+      if self.class.const_defined? :Rails
+        return configuration[Rails.env.to_sym] if configuration[Rails.env.to_sym]
+      end
+
+      configuration
+    end
+
+    def symbolize_keys_recursive(hash)
+      hash.inject({}) do |h, kv|
+        (key, value) = kv
+        h[key.to_sym] = regularize_for_symbolization(value)
+        h
+      end
+    end
+
+    if const_defined?(:ActiveSupport) && Hash.instance_methods.include?(:symbolize_keys) &&
+      const_get(:ActiveSupport).const_defined?(:HashWithIndifferentAccess)
+      def regularize_for_symbolization(value)
+        case value
+          when ActiveSupport::HashWithIndifferentAccess
+            value
+          when Hash
+            value.symbolize_keys
+          when Array
+            value.map{|v|regularize_for_symbolization(v)}
+          else
+            value
+        end
+      end
+    else
+      def regularize_for_symbolization(value)
+        case value
+          when Hash
+            value.inject({}) do |h, kv|
+              (key, value) = kv
+              h[key.to_sym] = regularize_for_symbolization(value)
+              h
+            end
+          when Array
+            value.map{|v|regularize_for_symbolization(v)}
+          else
+              value
+        end
+      end
+    end
+  end
+end

data/spec/.gitignore

@@ -0,0 +1 @@
+config.yml

data/spec/config.example.yml

@@ -0,0 +1,7 @@
+app_endpoint:
+  ios:
+    arn: "arn:aws:sns:<Your Region>:<Your Account ID>:app/<YourApp.sandbox? ? APNS_SANDBOX : APNS>/<Your App's name>"
+account:
+  access_key_id: "<Your Access Key>"
+  secret_access_key: "<Your Secret Key>"
+  region: '<Your Region>'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: j7w1
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- condor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mobile apps push client
+email:
+- condor1226@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- j7w1.gemspec
+- lib/generators/j7_w1/migration/migration_generator.rb
+- lib/generators/j7_w1/migration/templates/active_record/migration.rb
+- lib/generators/j7_w1/model/model_generator.rb
+- lib/generators/j7_w1/model/templates/j7_w1_application_device.rb.erb
+- lib/generators/j7_w1/model/templates/j7_w1_create_endpoint_worker.rb
+- lib/generators/j7_w1/model/templates/j7_w1_destroy_endpoint_worker.rb
+- lib/j7_w1/active_record_ext.rb
+- lib/j7_w1/concrete.rb
+- lib/j7_w1/configuration.rb
+- lib/j7_w1/push_client.rb
+- lib/j7_w1/stub.rb
+- lib/j7_w1/version.rb
+- lib/j7w1.rb
+- spec/.gitignore
+- spec/config.example.yml
+homepage: ''
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Mobile apps push client
+test_files:
+- spec/.gitignore
+- spec/config.example.yml