hsquare 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc918c686257ac4d8b60bcc048478af856fc2c5d
-  data.tar.gz: 384c6efac79fedb378ff6cc33cc8b4f577e90059
+  metadata.gz: a6accecebc76281dd41587f399dcbbf5da0a7716
+  data.tar.gz: 76d95e3e9a90d33098b110812b735a97365e7351
 SHA512:
-  metadata.gz: 9cb102be70277076f0b11bf91538e0f68eb61e17f25df3ba74df3e461c1ac2a0e3d03d3edbdfd54b333b42a755a62bc9c3a00a25b4360df13d52c6b0973e2dc0
-  data.tar.gz: 81ada066c79ce2686a76b73b3e8994e0fb0d76b68d8b0bd1133f3a60e8fbabb8d8c1f4ea62805b7b7beb2dc538d305629061ff87eddfba4fe5f8314b6c242a4e
+  metadata.gz: b3ec2cb67d65ea50ee6e4a3cfc90a0fc5de57595729d8a75abc40ef3dd95ddc37c40be588052eacf3c21180f69e2c9f7100d2fc7bdd67ad77b96a60f0cc3f93b
+  data.tar.gz: f719ef6fab4063965563dbf9b9a453895caadd65f7e3c8d5f4a8bbf567b372ed240e6fa9c1e3bc36c12117ab5f6a60366e9dfa2fcf4ac5662465751ee1a2f224

data/README.md

@@ -41,6 +41,26 @@ end
 Admin 키는 외부에 노출되지 않도록 보안에 주의를 기울여야 합니다. 환경 변수
 등으로 소스 컨트롤에서 분리하여 설정하도록 처리하는 것을 추천합니다.
 
+#### 여러 애플리케이션 동시에 사용하기
+
+어떤 클라이언트 애플리케이션의 패키징이 여러 가지로 달라질 수 있는 경우에
+여러 애플리케이션을 등록하고 사용할 수 있습니다. 이러한 경우 아래와 같이
+해당 애플리케이션들의 Admin key를 설정합니다.
+
+```ruby
+# In config/initializers/hsquare.rb
+
+Hsquare.config do |config|
+  config.application(:main) do |application|
+    application.admin_key = 'Main 애플리케이션의 Admin 키'
+  end
+
+  config.application(:beta) do |application|
+    application.admin_key = 'Beta 애플리케이션의 Admin 키'
+  end
+end
+```
+
 ### 푸시 알림
 
 #### 기기의 푸시 토큰 등록
@@ -50,10 +70,11 @@ Admin 키는 외부에 노출되지 않도록 보안에 주의를 기울여야
 
 ```ruby
 device = Hsquare::Device.new(
-  id: (애플리케이션 내 기기 ID),
-  user_id: (애플리케이션 사용자 ID),
-  token: '푸시 토큰',
-  type: '(apns 또는 gcm)'
+  id: 'device-1',           # 애플리케이션 내 기기 ID
+  user_id: 1,               # 애플리케이션 사용자 ID
+  token: 'apns-push-token', # 푸시 토큰
+  type: 'apns'              # apns 또는 gcm
+  application: nil          # 애플리케이션 종류, 주어지지 않은 경우 첫 (혹은 default) 애플리케이션
 )
 ```
 
@@ -61,7 +82,7 @@ device = Hsquare::Device.new(
 있습니다.
 
 ```ruby
-device.register # Open Platform API가 호출됩니다.
+device.register # 기기를 등록하는 Open Platform API를 호출합니다.
 ```
 
 클라이언트에서 푸시 토큰을 등록하도록 처리되어 있다면 이 과정은 거치지 않아도

data/lib/hsquare.rb

@@ -1,6 +1,7 @@
 require 'httparty'
 
 require 'hsquare/version'
+require 'hsquare/application'
 require 'hsquare/configuration'
 require 'hsquare/client'
 require 'hsquare/device'
@@ -31,14 +32,27 @@ module Hsquare
   #
   # Returns nothing.
   def self.apply(configuration)
-    Hsquare::Client::Admin.admin_key = configuration.admin_key if configuration.admin_key
-
     if configuration.http_proxy
       http_proxy_uri = URI.parse(configuration.http_proxy)
 
       Hsquare::Client.http_proxy http_proxy_uri.host, http_proxy_uri.port
     end
 
+    configuration.applications.each(&:refresh_admin_client)
+
     @configuration = configuration
   end
+
+  # Public: Finds application with given label.
+  #
+  # label - Label of the applcation.
+  #
+  # Returns registered Hsquare::Application object.
+  def self.application(label = nil)
+    if label
+      @configuration.applications.detect { |application| application.label == label.to_sym }
+    else
+      @configuration.default_application
+    end
+  end
 end

data/lib/hsquare/application.rb

@@ -0,0 +1,40 @@
+module Hsquare
+  # Public: Application registered on developers.kakao.com
+  class Application
+    # Public: Distinctive label of the application.
+    attr_accessor :label
+
+    # Public: Admin access key of the application.
+    attr_accessor :admin_key
+
+    # Public: Initializes new application object.
+    #
+    # attributes - Attributes for the new application.
+    #              :label     - Label of the application.
+    #              :admin_key - Admin API key for the application.
+    #
+    # Returns newly initialized application object.
+    def initialize(attributes = {})
+      @label = attributes[:label]
+      @admin_key = attributes[:admin_key]
+    end
+
+    # Public: Client with admin key associated with the application.
+    #
+    # Returns client class for the application inherits Hsquare::Client.
+    def admin_client
+      @admin_client ||= Class.new(Hsquare::Client::Admin).tap do |klass|
+        klass.admin_key = admin_key if admin_key
+      end
+    end
+
+    # Public: Clears previously cached admin client.
+    #
+    # Returns newly created admin client.
+    def refresh_admin_client
+      @admin_client = nil
+
+      admin_client
+    end
+  end
+end

data/lib/hsquare/configuration.rb

@@ -1,10 +1,48 @@
 module Hsquare
   # Public: Configuration object for Hsquare.
   class Configuration
-    # Public: Admin access key of Kakao application.
-    attr_accessor :admin_key
-
     # Public: HTTP proxy URI.
     attr_accessor :http_proxy
+
+    # Public: Sets admin key for default application.
+    #
+    # admin_key - Admin key to set.
+    #
+    # Returns newly set admin key.
+    def admin_key=(admin_key)
+      default_application.admin_key = admin_key
+    end
+
+    # Public: Retrieves default application.
+    #
+    # Returns Hsquare::Application object for default application.
+    def default_application
+      if @default_application
+        @default_application
+      elsif @applications && !@applications.empty?
+        @default_application ||= @applications.first
+      else
+        @default_application ||= Hsquare::Application.new
+      end
+    end
+
+    # Public: Retrieves list of registered applications.
+    #
+    # Returns Array of registered applications.
+    def applications
+      @applications ||= [default_application]
+    end
+
+    # Public: Adds a new application.
+    #
+    # Returns nothing.
+    def application(label = nil, &block)
+      new_application = Hsquare::Application.new(label: label)
+
+      @default_application ||= new_application
+      applications.push(new_application) unless applications.include?(new_application)
+
+      yield new_application
+    end
   end
 end

data/lib/hsquare/device.rb

@@ -16,11 +16,13 @@ module Hsquare
     # Public: Fetch devices for given user.
     #
     # user_or_user_id - User or ID of user.
+    # options         - Further options
+    #                   :application - Label of the application.
     #
     # Returns Array of HSquare::Device objects retrieved from the server.
-    def self.find_by_user_id(user_or_user_id)
+    def self.find_by_user_id(user_or_user_id, options = {})
       user_id = user_or_user_id.respond_to?(:id) ? user_or_user_id.id : user_or_user_id
-      response = Hsquare::Client::Admin.get('/v1/push/tokens', query: { uuid: user_id })
+      response = Hsquare.application(options[:application]).admin_client.get('/v1/push/tokens', query: { uuid: user_id })
 
       response.parsed_response.map do |device_response|
         new(device_response.symbolize_keys)
@@ -65,13 +67,14 @@ module Hsquare
       @user_id = attributes[:user_id] || attributes[:uuid]
       @token = attributes[:token] || attributes[:push_token]
       @type = attributes[:type] || attributes[:push_type]
+      @application = attributes[:application]
     end
 
     # Public: Registers the device via Kakao API.
     #
     # Returns Number of days before invalidation.
     def register
-      Hsquare::Client::Admin.post('/v1/push/register', body: {
+      client.post('/v1/push/register', body: {
         uuid: user_id, device_id: id, push_type: type, push_token: token.gsub(/\s/, '')
       })
     end
@@ -80,9 +83,18 @@ module Hsquare
     #
     # Returns Number of days before invalidation.
     def unregister
-      Hsquare::Client::Admin.post('/v1/push/deregister', body: {
+      client.post('/v1/push/deregister', body: {
         uuid: user_id, device_id: id, push_type: type
       })
     end
+
+    protected
+
+    # Internal: Client to use for API request.
+    #
+    # Returns Hsquare::Client class for associated application.
+    def client
+      Hsquare.application(@application).admin_client
+    end
   end
 end

data/lib/hsquare/notification.rb

@@ -65,7 +65,9 @@ module Hsquare
     #
     # Returns nothing.
     def deliver
-      Hsquare::Client::Admin.post('/v1/push/send', body: payload)
+      Hsquare.config.applications.each do |application|
+        application.admin_client.post('/v1/push/send', body: payload)
+      end
     end
 
     protected

data/lib/hsquare/version.rb

@@ -1,3 +1,3 @@
 module Hsquare
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/lib/hsquare/application_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+RSpec.describe Hsquare::Application do
+  describe '#admin_client' do
+    let(:application) { Hsquare::Application.new }
+
+    context 'when admin key is set' do
+      let(:admin_key) { 'admin-key' }
+      let(:application) { Hsquare::Application.new admin_key: admin_key }
+
+      it { expect(application.admin_client.default_options).not_to be_empty }
+      it { expect(application.admin_client.default_options[:headers]).not_to be_empty }
+      it { expect(application.admin_client.default_options[:headers]['Authorization']).to eq("KakaoAK #{admin_key}") }
+    end
+
+    context 'when proxy is set' do
+      let(:configuration) { Hsquare::Configuration.new.tap { |c| c.http_proxy = 'http://proxy.com:80' } }
+
+      before { Hsquare.apply(configuration) }
+
+      it { expect(application.admin_client.default_options).not_to be_empty }
+      it { expect(application.admin_client.default_options[:http_proxyaddr]).to eq('proxy.com') }
+    end
+  end
+end

data/spec/lib/hsquare/client_spec.rb

@@ -5,6 +5,8 @@ RSpec.describe Hsquare::Client do
     describe '#admin_key=' do
       let(:admin_key) { 'admin-key' }
 
+      before { Hsquare::Client::Admin.admin_key = nil }
+
       it { expect { Hsquare::Client::Admin.admin_key = admin_key }.to change { Hsquare::Client::Admin.default_options } }
       it { expect { Hsquare::Client::Admin.admin_key = admin_key }.not_to change { Hsquare::Client.default_options } }
     end

data/spec/lib/hsquare/configuration_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe Hsquare::Configuration do
+  describe '#application' do
+    let(:configuration) { Hsquare::Configuration.new }
+
+    context 'when it is first invocation' do
+      let(:admin_key) { 'adminkey' }
+
+      it { configuration.application { |a| a.admin_key = admin_key }; expect(configuration.default_application.admin_key).to eq(admin_key) }
+    end
+
+    context 'when it is second invocation' do
+      before { configuration.application { |a| a.admin_key = 'first' } }
+
+      let(:label) { :second_application }
+      let(:admin_key) { 'adminkey' }
+
+      it { configuration.application(label) { |a| a.admin_key = admin_key }; expect(configuration.default_application.admin_key).not_to eq(admin_key) }
+      it { configuration.application(label) { |a| a.admin_key = admin_key }; expect(configuration.applications.last.admin_key).to eq(admin_key) }
+      it { configuration.application(label) { |a| a.admin_key = admin_key }; expect(configuration.applications.last.label).to eq(label) }
+    end
+  end
+end

data/spec/lib/hsquare/device_spec.rb

@@ -1,11 +1,13 @@
 require 'spec_helper'
 
 RSpec.describe Hsquare::Device do
+  let(:client) { Hsquare.config.default_application.admin_client }
+
   describe '.find_by_user_id' do
     let(:user_id) { 123 }
     let(:mock_response) { double(parsed_response: []) }
 
-    it { expect(Hsquare::Client::Admin).to receive(:get).with('/v1/push/tokens', query: { uuid: user_id }).and_return(mock_response); Hsquare::Device.find_by_user_id(user_id) }
+    it { expect(client).to receive(:get).with('/v1/push/tokens', query: { uuid: user_id }).and_return(mock_response); Hsquare::Device.find_by_user_id(user_id) }
   end
 
   describe '#initialize' do
@@ -35,13 +37,13 @@ RSpec.describe Hsquare::Device do
     let(:attributes) { { id: 1, user_id: 2, type: 'apns', token: 'token' } }
     let(:device) { Hsquare::Device.new(attributes) }
 
-    it { expect(Hsquare::Client::Admin).to receive(:post).with('/v1/push/register', body: { uuid: device.user_id, device_id: device.id, push_type: device.type, push_token: device.token }); device.register }
+    it { expect(client).to receive(:post).with('/v1/push/register', body: { uuid: device.user_id, device_id: device.id, push_type: device.type, push_token: device.token }); device.register }
   end
 
   describe '#unregister' do
     let(:attributes) { { id: 1, user_id: 2, type: 'apns', token: 'token' } }
     let(:device) { Hsquare::Device.new(attributes) }
 
-    it { expect(Hsquare::Client::Admin).to receive(:post).with('/v1/push/deregister', body: { uuid: device.user_id, device_id: device.id, push_type: device.type }); device.unregister }
+    it { expect(client).to receive(:post).with('/v1/push/deregister', body: { uuid: device.user_id, device_id: device.id, push_type: device.type }); device.unregister }
   end
 end

data/spec/lib/hsquare/notification_spec.rb

@@ -6,7 +6,13 @@ RSpec.describe Hsquare::Notification do
     let(:message) { 'message' }
     let(:notification) { Hsquare::Notification.new(recipient_id: recipient_id, message: message) }
 
-    it { expect(Hsquare::Client::Admin).to receive(:post).with('/v1/push/send', body: { uuids: [recipient_id].to_json, push_message: { for_apns: { push_alert: true, message: message }, for_gcm: { delay_while_idle: false, custom_field: { message: message } } }.to_json }); notification.deliver }
+    it do
+      Hsquare.config.applications.each do |application|
+        expect(application.admin_client).to receive(:post).with('/v1/push/send', body: { uuids: [recipient_id].to_json, push_message: { for_apns: { push_alert: true, message: message }, for_gcm: { delay_while_idle: false, custom_field: { message: message } } }.to_json })
+      end
+
+      notification.deliver
+    end
   end
 
   describe '#recipient_id=' do

data/spec/lib/hsquare_spec.rb

@@ -15,11 +15,29 @@ RSpec.describe Hsquare do
     end
 
     context 'when admin_key is set' do
+      before { Hsquare.apply(configuration) }
       before { configuration.admin_key = 'admin-key' }
 
       it { expect { Hsquare.apply(configuration) }.not_to change { Hsquare::Client.default_options } }
-      it { expect { Hsquare.apply(configuration) }.to change { Hsquare::Client::Admin.admin_key } }
-      it { expect { Hsquare.apply(configuration) }.to change { Hsquare::Client::Admin.default_options } }
+      it { expect { Hsquare.apply(configuration) }.not_to change { Hsquare::Client::Admin.default_options } }
+      it { expect { Hsquare.apply(configuration) }.to change { Hsquare.config.default_application.admin_client.default_options } }
     end
   end
+
+  describe '.application' do
+    let(:configuration) { Hsquare::Configuration.new }
+
+    before { configuration.application(:first) { |a| a.admin_key = 'firstkey' } }
+    before { configuration.application(:second) { |a| a.admin_key = 'secondkey' } }
+    before { Hsquare.apply(configuration) }
+
+    it { expect(Hsquare.application(:first)).not_to be_nil }
+    it { expect(Hsquare.application(:first).admin_key).to eq('firstkey') }
+    it { expect(Hsquare.application(:second)).not_to be_nil }
+    it { expect(Hsquare.application(:second).admin_key).to eq('secondkey') }
+    it { expect(Hsquare.application(:third)).to be_nil }
+    it { expect(Hsquare.application).not_to be_nil }
+    it { expect(Hsquare.application.label).to eq(:first) }
+    it { expect(Hsquare.application.admin_key).to eq('firstkey') }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hsquare
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Inbeom Hwang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-12 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -81,12 +81,15 @@ files:
 - Rakefile
 - hsquare.gemspec
 - lib/hsquare.rb
+- lib/hsquare/application.rb
 - lib/hsquare/client.rb
 - lib/hsquare/configuration.rb
 - lib/hsquare/device.rb
 - lib/hsquare/notification.rb
 - lib/hsquare/version.rb
+- spec/lib/hsquare/application_spec.rb
 - spec/lib/hsquare/client_spec.rb
+- spec/lib/hsquare/configuration_spec.rb
 - spec/lib/hsquare/device_spec.rb
 - spec/lib/hsquare/notification_spec.rb
 - spec/lib/hsquare_spec.rb
@@ -117,7 +120,9 @@ signing_key:
 specification_version: 4
 summary: Client library for Kakao Developers Open Platform API
 test_files:
+- spec/lib/hsquare/application_spec.rb
 - spec/lib/hsquare/client_spec.rb
+- spec/lib/hsquare/configuration_spec.rb
 - spec/lib/hsquare/device_spec.rb
 - spec/lib/hsquare/notification_spec.rb
 - spec/lib/hsquare_spec.rb