boxcar_api 1.0.0 → 1.0.1

data/Manifest

@@ -2,6 +2,7 @@ LICENSE
 Manifest
 README.rdoc
 Rakefile
+boxcar_api.gemspec
 examples/send_as_provider.rb
 examples/send_to_yourself.rb
 init.rb

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('boxcar_api', '1.0.0') do |p|
+Echoe.new('boxcar_api', '1.0.1') 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"

data/boxcar_api.gemspec

@@ -2,21 +2,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{boxcar_api}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   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.date = %q{2010-11-06}
   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.files = ["LICENSE", "Manifest", "README.rdoc", "Rakefile", "boxcar_api.gemspec", "examples/send_as_provider.rb", "examples/send_to_yourself.rb", "init.rb", "lib/boxcar_api.rb"]
   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.rubygems_version = %q{1.3.6}
   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.}
 

data/examples/send_as_provider.rb

@@ -1,16 +1,19 @@
 require 'rubygems'
 require 'boxcar_api'
 
-provider_key = 'xyz'
-provider_secret = 'xyz'
+SETTINGS = {
+  :provider_key => 'xyz',
+  :provider_secret => 'xyz',
+  :email => 'user@example.com'
+}
 
-bp = Provider.new(provider_key, provider_secret)
+bp = BoxcarAPI::Provider.new(SETTINGS[:provider_key], SETTINGS[:provider_key])
 
 #### Send an invitation to a user by their e-mail address, to add your service.
-res = bp.subscribe('user@example.com')
+res = bp.subscribe(SETTINGS[:email])
 
 if res.code == 200
-  puts "Success!  You sent an invitation to user@example.com to add your service."
+  puts "Success!  You sent an invitation to #{SETTINGS[:email]} to add your service."
 else
   puts "Problem!  HTTP status code: #{res.code}.  Check the API docs!"
 end
@@ -25,19 +28,54 @@ else
 end
 
 #### Deliver a personalized notification to a subscriber by email.
-res = bp.broadcast("user@example.com", "This is an example message.", "from")
+res = bp.notify(SETTINGS[:email], "This is an example message.", "from")
 
 if res.code == 200
-  puts "Success!  You sent a broadcast message to everyone using your service."
+  puts "Success!  You sent a personalized message to #{SETTINGS[:email]}."
 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")
+#### Deliver a personalized notification to a subscriber by email, but only deliver it once!
+# This includes the from_remote_service_id for the user, which will ensure it's only delivered one time.
+res = bp.notify(SETTINGS[:email], "This is an example message.", "from", "123")
 
 if res.code == 200
-  puts "Success!  You sent a broadcast message to everyone using your service."
+  puts "Success!  You sent a personalized message to #{SETTINGS[:email]}."
+else
+  puts "Problem!  HTTP status code: #{res.code}.  Check the API docs!"
+end
+
+#### Deliver a personalized notification to a subscriber by email, including a redirect payload
+# Redirect payloads are what replaces "::user::" in your Boxcar redirect URL.
+
+res = bp.notify(SETTINGS[:email], "This is an example message.", "from", nil, "jdg")
+if res.code == 200
+  puts "Success!  You sent a personalized message with a redirect payload to #{SETTINGS[:email]}."
+else
+  puts "Problem!  HTTP status code: #{res.code}.  Check the API docs!"
+end
+
+#### Deliver a personalized notification to a subscriber by email, including a redirect payload
+# Redirect payloads are what replaces "::user::" in your Boxcar redirect URL.
+# Also include a source_url and an icon_url
+
+res = bp.notify(SETTINGS[:email], "This is an example message.", "from", nil, "jdg", "http://google.com", 
+                "http://graph.facebook.com/jonathan.george/picture")
+if res.code == 200
+  puts "Success!  You sent a personalized message with a redirect payload, source_url and icon_url to #{SETTINGS[:email]}."
 else
   puts "Problem!  HTTP status code: #{res.code}.  Check the API docs!"
-end
+end
+
+
+#### Deliver a personalized notification to a subscriber by their service token/secret.
+#### This works, just commented out because it's much easier to use e-mail addresses.
+#
+#res = bp.notify_service(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

@@ -16,6 +16,10 @@ end
 # This time include a 'from screen name' - e.g., an application name, or a person.
 res = bu.notify("message", "from")
 
+# This time include an 'icon url' - a link to an icon hosted online.
+# Also include a 'source url', a link that we'll take you to when you chose to View Original for the notification.
+res = bu.notify("message", "from", nil, "http://facebook.com", "http://graph.facebook.com/jonathan.george/picture")
+
 # 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")

data/lib/boxcar_api.rb

@@ -21,40 +21,46 @@ module BoxcarAPI
       self.class.post("/subscribe", options)
     end
 
-    def broadcast(message, from_screen_name = nil, from_remote_service_id = nil, redirect_payload = nil)
+    def broadcast(message, from_screen_name = nil, from_remote_service_id = nil, redirect_payload = nil, source_url = nil, icon_url = 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
+          :redirect_payload => redirect_payload,
+          :source_url => source_url,
+          :icon_url => icon_url
         } 
       }}
 
       self.class.post("/broadcast", options)
     end
 
-    def notify(email, message, from_screen_name = nil, from_remote_service_id = nil, redirect_payload = nil)
+    def notify(email, message, from_screen_name = nil, from_remote_service_id = nil, redirect_payload = nil, source_url = nil, icon_url = 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
+          :source_url => source_url,
+          :icon_url => icon_url
         } 
       }}
 
       self.class.post("/", options)
     end
 
-    def notify_service(token, secret, message, from_screen_name = nil, from_remote_service_id = nil, redirect_payload = nil)
+    def notify_service(token, secret, message, from_screen_name = nil, from_remote_service_id = nil, redirect_payload = nil, source_url = nil, icon_url = 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
-        } 
+          :source_url => source_url,
+          :icon_url => icon_url
+        }
       }}
 
       self.class.post("/", options)
@@ -76,13 +82,15 @@ module BoxcarAPI
       @auth = { :username => email, :password => password }
     end
 
-    def notify(message, from_screen_name = nil, from_remote_service_id = nil)
+    def notify(message, from_screen_name = nil, from_remote_service_id = nil, source_url = nil, icon_url = nil)
       options = { :basic_auth => @auth, :body => { 
         :notification => {
           :message => message,
           :from_screen_name => from_screen_name,
-          :from_remote_service_id => from_remote_service_id
-        } 
+          :from_remote_service_id => from_remote_service_id,
+          :icon_url => icon_url,
+          :source_url => source_url
+        }
       }}
 
       self.class.post("/", options)

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: boxcar_api
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Jonathan George
@@ -30,29 +35,33 @@ cert_chain:
   YhU=
   -----END CERTIFICATE-----
 
-date: 2010-04-13 00:00:00 -05:00
+date: 2010-11-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: httparty
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 description: A simple way to send notifications to yourself, or your users through Boxcar.
 email: help@boxcar.io
 executables: []
@@ -68,11 +77,11 @@ files:
 - Manifest
 - README.rdoc
 - Rakefile
+- boxcar_api.gemspec
 - 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: []
@@ -91,18 +100,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: boxcar_api
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A simple way to send notifications to yourself, or your users through Boxcar.