boxcar_api 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Boxcar
+
+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/Manifest

@@ -0,0 +1,8 @@
+LICENSE
+Manifest
+README.rdoc
+Rakefile
+examples/send_as_provider.rb
+examples/send_to_yourself.rb
+init.rb
+lib/boxcar_api.rb

data/README.rdoc

@@ -0,0 +1,12 @@
+= Boxcar API
+
+The Boxcar API gem allows Ruby developers to programmatically deliver notifications either to themselves, or as a provider.
+
+To send yourself notifications, visit http://boxcar.io/help/api/users
+
+To send other people notifications, visit http://boxcar.io/help/api/providers
+
+
+== Copyright
+
+Copyright (c) 2010 Boxcar. MIT Licensed.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('boxcar_api', '1.0.0') do |p|
+  p.description    = "A simple way to send notifications to yourself, or your users through Boxcar."
+  p.url            = "http://github.com/boxcar/boxcar_api"
+  p.author         = "Jonathan George"
+  p.email          = "help@boxcar.io"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = ["httparty"]
+  p.runtime_dependencies = ["httparty"]
+end

data/boxcar_api.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{boxcar_api}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jonathan George"]
+  s.cert_chain = ["/Users/jonathan/.ssh/gem-public_cert.pem"]
+  s.date = %q{2010-04-13}
+  s.description = %q{A simple way to send notifications to yourself, or your users through Boxcar.}
+  s.email = %q{help@boxcar.io}
+  s.extra_rdoc_files = ["LICENSE", "README.rdoc", "lib/boxcar_api.rb"]
+  s.files = ["LICENSE", "Manifest", "README.rdoc", "Rakefile", "examples/send_as_provider.rb", "examples/send_to_yourself.rb", "init.rb", "lib/boxcar_api.rb", "boxcar_api.gemspec"]
+  s.homepage = %q{http://github.com/boxcar/boxcar_api}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Boxcar_api", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{boxcar_api}
+  s.rubygems_version = %q{1.3.5}
+  s.signing_key = %q{/Users/jonathan/.ssh/gem-private_key.pem}
+  s.summary = %q{A simple way to send notifications to yourself, or your users through Boxcar.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<httparty>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+end

data/examples/send_as_provider.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'boxcar_api'
+
+provider_key = 'xyz'
+provider_secret = 'xyz'
+
+bp = Provider.new(provider_key, provider_secret)
+
+#### Send an invitation to a user by their e-mail address, to add your service.
+res = bp.subscribe('user@example.com')
+
+if res.code == 200
+  puts "Success!  You sent an invitation to user@example.com to add your service."
+else
+  puts "Problem!  HTTP status code: #{res.code}.  Check the API docs!"
+end
+
+#### Deliver a broadcast notification to everyone that has added your service.
+res = bp.broadcast("This is an example message.", "from")
+
+if res.code == 200
+  puts "Success!  You sent a broadcast message to everyone using your service."
+else
+  puts "Problem!  HTTP status code: #{res.code}.  Check the API docs!"
+end
+
+#### Deliver a personalized notification to a subscriber by email.
+res = bp.broadcast("user@example.com", "This is an example message.", "from")
+
+if res.code == 200
+  puts "Success!  You sent a broadcast message to everyone using your service."
+else
+  puts "Problem!  HTTP status code: #{res.code}.  Check the API docs!"
+end
+
+#### Deliver a personalized notification to a subscriber by their service token/secret.
+res = bp.broadcast(token, secret, "This is an example message.", "from")
+
+if res.code == 200
+  puts "Success!  You sent a broadcast message to everyone using your service."
+else
+  puts "Problem!  HTTP status code: #{res.code}.  Check the API docs!"
+end

data/examples/send_to_yourself.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'boxcar_api'
+
+email = 'your email'
+password = 'your password'
+
+bu = BoxcarAPI::User.new(email, password)
+res = bu.notify("message")
+
+if res.code == 200
+  puts "Success!"
+else
+  puts "There was a problem delivering the notification, HTTP status code: #{res.code}"
+end
+
+# This time include a 'from screen name' - e.g., an application name, or a person.
+res = bu.notify("message", "from")
+
+# This time include a unique identifier, and if you send it more than once
+# additional notifications will be dropped as duplicates.
+res = bu.notify("message", "from", "unique")
+
+# This one won't be delivered, because you've already gotten it.
+res = bu.notify("message", "from", "unique")

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "boxcar_api")

data/lib/boxcar_api.rb

@@ -0,0 +1,91 @@
+require 'rubygems'
+require 'httparty'
+require 'digest/md5'
+
+module BoxcarAPI
+
+################### For Providers - http://boxcar.io/help/api/providers
+  class Provider
+    include HTTParty
+    attr_accessor :provider_key, :provider_secret
+
+    def initialize(provider_key, provider_secret)
+      @provider_key = provider_key
+      @provider_secret = provider_secret
+
+      self.class.base_uri "https://boxcar.io/devices/providers/#{@provider_key}/notifications"
+    end
+
+    def subscribe(email)
+      options = { :body => { :email => hashed_email(email) } }
+      self.class.post("/subscribe", options)
+    end
+
+    def broadcast(message, from_screen_name = nil, from_remote_service_id = nil, redirect_payload = nil)
+      options = { :body => { :secret => provider_secret,
+        :notification => {
+          :message => message,
+          :from_screen_name => from_screen_name,
+          :from_remote_service_id => from_remote_service_id,
+          :redirect_payload => redirect_payload
+        } 
+      }}
+
+      self.class.post("/broadcast", options)
+    end
+
+    def notify(email, message, from_screen_name = nil, from_remote_service_id = nil, redirect_payload = nil)
+      options = { :body => { :email => hashed_email(email),
+        :notification => {
+          :message => message,
+          :from_screen_name => from_screen_name,
+          :from_remote_service_id => from_remote_service_id,
+          :redirect_payload => redirect_payload
+        } 
+      }}
+
+      self.class.post("/", options)
+    end
+
+    def notify_service(token, secret, message, from_screen_name = nil, from_remote_service_id = nil, redirect_payload = nil)
+      options = { :body => { :token => token, :secret => secret,
+        :notification => {
+          :message => message,
+          :from_screen_name => from_screen_name,
+          :from_remote_service_id => from_remote_service_id,
+          :redirect_payload => redirect_payload
+        } 
+      }}
+
+      self.class.post("/", options)
+    end
+
+  private
+    def hashed_email(email)
+      email =~ /@/ ? Digest::MD5.hexdigest(email) : email
+    end
+  end
+
+################### For Users - http://boxcar.io/help/api/users
+  class User
+    include HTTParty
+    attr_accessor :auth
+    base_uri "https://boxcar.io/notifications"
+
+    def initialize(email, password)
+      @auth = { :username => email, :password => password }
+    end
+
+    def notify(message, from_screen_name = nil, from_remote_service_id = nil)
+      options = { :basic_auth => @auth, :body => { 
+        :notification => {
+          :message => message,
+          :from_screen_name => from_screen_name,
+          :from_remote_service_id => from_remote_service_id
+        } 
+      }}
+
+      self.class.post("/", options)
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: boxcar_api
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jonathan George
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDLjCCAhagAwIBAgIBADANBgkqhkiG9w0BAQUFADA9MREwDwYDVQQDDAhqb25h
+  dGhhbjETMBEGCgmSJomT8ixkARkWA2pkZzETMBEGCgmSJomT8ixkARkWA25ldDAe
+  Fw0xMDA0MTQwNDM2MDNaFw0xMTA0MTQwNDM2MDNaMD0xETAPBgNVBAMMCGpvbmF0
+  aGFuMRMwEQYKCZImiZPyLGQBGRYDamRnMRMwEQYKCZImiZPyLGQBGRYDbmV0MIIB
+  IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1k3X9E577+SaAuYby0S3Jk58
+  iEY0E3Y4XGtQap1FqaxVChvfwW1DmQrIZlVOWZY8CEX1227BaoMGDUt65LSYHY3r
+  uNHfp5AwPkmStBMgf/7lNIskwow57J3px/VnlRQSXFlmVXulEl7XVnGOzvRuKerf
+  BbA97J2ncCZXXSluTfAHwANSLqbsXuDAd8wZ8XoU/LTpZR5rJSE6XQxAmy64xcyY
+  S2TU630bUMjV2h6GmwiA5S4iXlK27+j2VUulMIx5PtA8jvLHOtHzXg0nvzwYZ5Tf
+  +rm+yoUf71swsntg9YZrlTVVHXaFMCa0+4jZQkCdSJu4yB3NsB7fE4tatOyPaQID
+  AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUZpPgZYDc
+  kuj7cbIholL8FIkEk5QwDQYJKoZIhvcNAQEFBQADggEBAJ6X/CMiC6OBR48ZOPzb
+  DUivkSXHbFfIIH2HatdI03ZaMVpdK1HHviqcuE38ArqefdjecSCse2eBn/KqACpL
+  h0oHYw095vgyP5qUca3+rYAxiNML0abqe6zrMqgGIqMpaeVl6+eoGP48rXbuXeK+
+  mFI6zYmFhj/Zjjp05UMRLP6eDFoMDyKHkYYKWCE8Hi8wqLih4qIgAKW3bmX8hkmb
+  zBuVRvW+f9iO8M5+m0J+DeR64biLxt8IV7gLj5oLXVYQXz2ran0xkqOrOMTsLf79
+  JYYCM1LV3QwoYfI9CRoIscg+7eLsLuQyDIVMLHvnoxJXIFjCkqWoIaeqvuOxA6Gy
+  YhU=
+  -----END CERTIFICATE-----
+
+date: 2010-04-13 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A simple way to send notifications to yourself, or your users through Boxcar.
+email: help@boxcar.io
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- lib/boxcar_api.rb
+files: 
+- LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- examples/send_as_provider.rb
+- examples/send_to_yourself.rb
+- init.rb
+- lib/boxcar_api.rb
+- boxcar_api.gemspec
+has_rdoc: true
+homepage: http://github.com/boxcar/boxcar_api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Boxcar_api
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: boxcar_api
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple way to send notifications to yourself, or your users through Boxcar.
+test_files: []
+

metadata.gz.sig

@@ -0,0 +1,4 @@
+զ�>�^������YvHS�cFɝ�����{s�?���9
+�Ե�xXp�_�gC@��&!��3�t�ѯ�MDƕ'�i	)�	0�diJB�]��(o�������9>�"�|�B�[�u*k��>}�ױ3vH���������S���1
+=��pdam{T5꼗��sW��-~�����JNƴq�mýw��g
U�/� ��rV=զң�[�D��Y�W����*���g
+}��ҭ%[�-F�}y��<�����֘