appush_client 0.2

data/CONTRIBUTORS

@@ -0,0 +1 @@
+* Igor Guerrero (igor@appush.com)

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,22 @@
+Appush Ruby Client
+==================
+
+Documentation is available at [http://appush.com/docs/client/ruby_client.html](http://appush.com/docs/client/ruby_client.html)
+
+License
+--------
+
+Copyright 2009 APPush, LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License. 
+

data/appush_client.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = 'appush_client'
+  s.version = '0.2'
+
+  s.authors = ['Igor Guerrero']
+  s.date = '2010-01-09'
+  s.description = "Ruby client library for Appush PUSH service."
+  s.email = ['igor@appush.com']
+  s.homepage = 'http://appush.com'
+  s.files = ['appush_client.gemspec', 'CONTRIBUTORS', 'LICENSE', 'README.md', 'lib/appush_client.rb',
+    'spec/appush_client_spec.rb']
+  s.summary = "Ruby client library for Appush PUSH service."
+
+  s.add_dependency 'rest-client', '>= 1.0'
+end

data/lib/appush_client.rb

@@ -0,0 +1,166 @@
+#appush_client.rb
+
+require 'json'
+require 'rest_client'
+
+class AppushClient
+  attr_accessor :user, :password, :protocol, :service_url
+
+  def initialize(user, password, params={})
+    params = {:service_url=>"https://appush.com/api"}.merge params
+    @user = user
+    @password = password
+
+    # cleaning params[:service_url], removing tailing "/"
+    params[:service_url] = clean_service_url(params[:service_url])
+
+    # http://xkcd.com/208/
+    @protocol = params[:service_url].match(/^https?:\/\//)[0] # match the protocol, http:// or https://
+    @url = params[:service_url].sub(/^https?:\/\//, '') # removes the protocol form the service
+
+    @service_url = "#{@protocol}#{@user}:#{@password}@#{@url}"
+  end
+
+  def to_s
+    "Server = #{@service_url}"
+  end
+
+  private
+
+  def clean_service_url(service_url)
+    while !service_url.match(/\/$/).nil?
+      service_url = service_url.sub(/\/$/, '')
+    end
+
+    service_url
+  end
+end
+
+class RootUser < AppushClient
+  # POST
+  def create_application(name, env="dev", dev_pem="", prod_pem="")
+    url = "#{@service_url}/application"
+    data = {:name=>name, :env=>env, :dev_pem=>dev_pem, :prod_pem=>prod_pem}.to_json
+
+    RestClient.post url, data, :content_type=>:json, :accept=>:json
+  end
+
+  # PUT
+  # parameters are optional: :name, :env, :dev_pem, :prod_pem
+  def modify_application(id, params={})
+    url = "#{@service_url}/application/#{id}"
+    data = Hash.new
+
+    data[:name] = params[:name] if params[:name]
+    data[:env] = params[:env] if params[:env]
+    data[:dev_pem] = params[:dev_pem] if params[:dev_pem]
+    data[:prod_pem] = params[:prod_pem] if params[:prod_pem]
+
+    data = data.to_json
+    RestClient.put url, data, :content_type=>:json, :accept=>:json
+  end
+
+  # GET
+  def list_applications()
+    url = "#{@service_url}/application"
+
+    RestClient.get url, :content_type=>:json, :accept=>:json
+  end
+
+  # GET <id>
+  def get_application(id)
+    url = "#{@service_url}/application/#{id}"
+
+    RestClient.get url, :content_type=>:json, :accept=>:json
+  end
+
+  # GET application/<id>/icon
+  def get_application_icon(id)
+    url = "#{@service_url}/application/#{id}/icon"
+
+    RestClient.get url, :content_type=>"image/png", :accept=>"image/png"
+  end
+
+  # PUT application/<id>/icon
+  def save_application_icon(app_id, icon)
+    url = "#{@service_url}/application/#{app_id}/icon"
+
+    RestClient.put url, icon, :content_type=>"image/png"
+  end
+
+  # DELETE <id>
+  def delete_application(id)
+    url = "#{@service_url}/application/#{id}"
+
+    RestClient.delete url, :content_type=>:json, :accept=>:json
+  end
+
+  # POST <id> send notification
+  def send_notification(app_id, params={})
+    url = "#{@service_url}/application/#{app_id}/notification"
+    params = {:tags=>[], :devices=>[], :exclude=>[], :alert=>"", :sound=>"", :badge=>0, :kv=>[]}.merge params
+
+    payload = {"aps"=>{"alert"=>params[:alert],
+                       "sound"=>params[:sound],
+                       "badge"=>params[:badge]}}.merge params[:kv]
+    payload = {"payload"=>payload}
+    data = {"tags"=>params[:tags],
+            "devices"=>params[:devices],
+            "exclude"=>params[:exclude]}.merge payload
+    data = data.to_json
+
+    RestClient.post url, data, :content_type=>:json, :accept=>:json
+  end
+
+  # GET get notification status
+  def get_notification_status(app_id, notification_id)
+    url = "#{@service_url}/application/#{app_id}/notification/#{notification_id}"
+    
+    RestClient.get url, :content_type=>:json, :accept=>:json
+  end
+
+  # GET all the devices with a tag
+  def get_devices_by_tag(app_id, tag)
+    url = "#{@service_url}/application/#{app_id}/tag/#{tag}"
+
+    RestClient.get url, :content_type=>:json, :accept=>:json
+  end
+end
+
+class Profile < AppushClient
+  # GET device info
+  def get_device(device_token)
+    url = "#{@service_url}/device/#{device_token}"
+
+    RestClient.get url, :content_type=>:json, :accept=>:json
+  end
+
+  # PUT register a device with tags
+  def register_device(device_token, tags=[])
+    url = "#{@service_url}/device/#{device_token}"
+
+    if tags.empty?
+      return RestClient.put url, :content_type=>:json, :accept=>:json
+    end
+
+    data = {:tags=>tags}.to_json
+
+    RestClient.put url, data, :content_type=>:json, :accept=>:json
+  end
+
+  # DELETE unregister device
+  def unregister_device(device_token)
+    url = "#{@service_url}/device/#{device_token}"
+
+    RestClient.delete url, :content_type=>:json, :accept=>:json
+  end
+end
+
+class Application < AppushClient
+  # POST
+  def create_profile()
+    url = "#{@service_url}/profile"
+    
+    RestClient.post url, "".to_json, :content_type=>:json, :accept=>:json
+  end
+end

data/spec/appush_client_spec.rb

@@ -0,0 +1,93 @@
+# appush_client_spec.rb
+
+require 'appush_client'
+require 'webmock/rspec'
+
+include WebMock
+
+describe "Using Appush client API" do
+  before(:each) do
+    @app_key = "I6ieYiJtbH3YPriyR3AK3VZtgSP"
+    @app_secret = "48907eb5efbffe9ee23e62e2b9273929"
+    @push_secret = "72781d3c6d508699e8f3918de6dceb25"
+    @service_url = "http://appush.com/api"
+
+    @client = AppushClient.new @app_key,
+                               @app_secret,
+                               :push_secret=>@push_secret,
+                               :service_url=>@service_url
+  end
+
+  it "should not be null" do
+    @client.should_not be nil
+    @client.to_s.should == "Appush Client = I6ieYiJtbH3YPriyR3AK3VZtgSP:48907eb5efbffe9ee23e62e2b9273929, Push Secret = 72781d3c6d508699e8f3918de6dceb25, Server = appush.com/api"
+    @client.protocol.should == "http://"
+  end
+  
+  it "should get device information" do
+    result = {"tags"=>["foo", "waa"], "status"=> 200}
+
+    stub_request(:get, "#{@client.protocol}#{@client.app_key}:#{@client.app_secret}@#{@client.service_url}/device/test_device").to_return(:body=>result.to_json)
+
+    @client.get_device("test_device").should == result
+
+    WebMock.should have_requested(:get, "#{@client.protocol}#{@client.app_key}:#{@client.app_secret}@#{@client.service_url}/device/test_device").once
+  end
+
+  it "should register devices" do
+    result = {"status"=>204}
+
+    stub_request(:put, "#{@client.protocol}#{@client.app_key}:#{@client.app_secret}@#{@client.service_url}/device/test_device2").to_return(:body=>result.to_json, :status=>204)
+
+    @client.register_device("test_device2").should == result
+
+    WebMock.should have_requested(:put, "#{@client.protocol}#{@client.app_key}:#{@client.app_secret}@#{@client.service_url}/device/test_device2").once
+  end
+
+  it "should unregister devices" do
+    result = {"status"=>204}
+
+    stub_request(:delete, "#{@client.protocol}#{@client.app_key}:#{@client.app_secret}@#{@client.service_url}/device/test_device").to_return(:body=>result.to_json, :status=>204)
+
+    @client.unregister_device("test_device").should == result
+
+    WebMock.should have_requested(:delete, "#{@client.protocol}#{@client.app_key}:#{@client.app_secret}@#{@client.service_url}/device/test_device").once
+  end
+
+  it "should get devices using a tag" do
+    result = {"devices"=>["test_device"],"status"=>200}
+
+    stub_request(:get, "#{@client.protocol}#{@client.app_key}:#{@client.push_secret}@#{@client.service_url}/tag/waa").to_return(:body=>result.to_json, :status=>200)
+
+    @client.get_devices_by_tag("waa").should == result
+
+    WebMock.should have_requested(:get, "#{@client.protocol}#{@client.app_key}:#{@client.push_secret}@#{@client.service_url}/tag/waa").once
+  end
+
+  it "should send notifications" do
+    result = {"status"=>201}
+    tags = ["foo", "waa"]
+    devices = ["test_device"]
+    exclude = ["invalid_device"]
+    alert = "hello"
+    sound = "meow.aiff"
+    badge = 1
+    kv = {"spam"=>"foo"}
+
+    stub_request(:post, "#{@client.protocol}#{@client.app_key}:#{@client.push_secret}@#{@client.service_url}/notification").to_return(:status=>201, :body=>result.to_json)
+
+    @client.send_notification(:tags=>tags, :devices=>devices, :exclude=>exclude, :alert=>alert, :sound=>sound, :badge=>badge, :kv=>kv).should == {"status"=>201}
+
+    WebMock.should have_requested(:post, "#{@client.protocol}#{@client.app_key}:#{@client.push_secret}@#{@client.service_url}/notification").once
+  end
+
+  it "should get notifications statuses" do
+    result = {"devices"=>["test_device"], "completed"=>0, "payload"=>{"aps"=>{"badge"=>1, "sound"=>"meow.aiff", "alert"=>"Hello World"}, "spam"=>"eggs"}, "delivered"=>[], "tags"=>["foo", "bar", "baz"], "status"=>200}
+
+    stub_request(:get, "#{@client.protocol}#{@client.app_key}:#{@client.push_secret}@#{@client.service_url}/notification/id_notify").to_return(:body=>result.to_json)
+
+    @client.get_notification_status("id_notify").should == result
+
+    WebMock.should have_requested(:get, "#{@client.protocol}#{@client.app_key}:#{@client.push_secret}@#{@client.service_url}/notification/id_notify").once
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: appush_client
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Igor Guerrero
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: Ruby client library for Appush PUSH service.
+email: 
+- igor@appush.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- appush_client.gemspec
+- CONTRIBUTORS
+- LICENSE
+- README.md
+- lib/appush_client.rb
+- spec/appush_client_spec.rb
+has_rdoc: true
+homepage: http://appush.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby client library for Appush PUSH service.
+test_files: []
+