boxcar_client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89a32f3ae3b5f034c20a2b6533aef7f3d8870c7f
-  data.tar.gz: 51562beaa0a64294a9c39b87a0742c4dcce432d5
+  metadata.gz: f0f7a69c0bbfead517a59779b521013fa85a2544
+  data.tar.gz: 50f25ab1138b2863a51a51c9174cfcbc8640c26e
 SHA512:
-  metadata.gz: c2c3fdd27535279611c5b485414a8803df4f633da0bb5c207903275bb2788783680568625bdb318511d374bfd0807e2b9201fe3beebe5ac8b9ef5d2bcbc6f022
-  data.tar.gz: 8ad6180e6933ca21929b17c1972da77e29b3e04be555a0a052fc843f637a71a2825851bf0befd1c9c46b28800298d3f7d9c06ea11b2b18d73e681efc84bf690d
+  metadata.gz: 38302c5bb149811f6a8099e14e167fbcd43d5ca3be1193e4b12730677117d347c3c9d3aa88bf62f48be16c7d10a9189aac8b7cf6bcbab2ce44e4dd991071bc92
+  data.tar.gz: b331d7ac16f29386c6a439359af92b7e9b04d166012ea2b789d00ab9a4bd49b38ea97ef2854b94338f99d549d855f6acda33151c9a18f69e5b361788f01a6c0f

data/README.md

@@ -1,4 +1,4 @@
-# Boxcar
+# BoxcarClient
 
 TODO: Write a gem description
 
@@ -18,7 +18,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Add the following into config/initializers/boxcar.rb:
+
+    BoxcarClient.configure do |config|
+      config.api_key = '<API_KEY>'
+      config.icon_url = '<ICON_URL>'
+      config.from_screen_name = '<NAME>'
+    end
+
+2. To send a push notification from anywhere in your application:
+
+   BoxcarClient::Notifier.push(
+     :message => "A push from Rails",
+    :email   => "unni@bangthetable.com",
+    :source_url => "http://google.com"
+   )
+
+
+
 
 ## Contributing
 

data/{boxcar.gemspec → boxcar_client.gemspec}

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'boxcar/version'
+require 'boxcar_client/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "boxcar_client"
-  spec.version       = Boxcar::VERSION
+  spec.version       = BoxcarClient::VERSION
   spec.authors       = ["Srihari, Unni"]
   spec.email         = ["srih4ri@gmail.com, unni@bangthetable.com"]
   spec.description   = %q{A ruby wrapper for BoxCar API}

data/lib/{boxcar.rb → boxcar_client.rb}

@@ -1,12 +1,12 @@
-require "boxcar/version"
-require "boxcar/configuration"
-require "boxcar/agent"
-require "boxcar/notifier"
+require "boxcar_client/version"
+require "boxcar_client/configuration"
+require "boxcar_client/agent"
+require "boxcar_client/notifier"
 
 require "net/http"
 require "uri"
 
-module Boxcar
+module BoxcarClient
   class << self
     attr_writer :configuration
 

data/lib/{boxcar → boxcar_client}/agent.rb

@@ -1,4 +1,4 @@
-module Boxcar
+module BoxcarClient
   class Agent
     def initialize(push_url, data)
       @push_url = push_url

data/lib/{boxcar → boxcar_client}/configuration.rb

@@ -1,4 +1,4 @@
-module Boxcar
+module BoxcarClient
   class Configuration
     attr_accessor :api_key, :icon_url, :from_screen_name
 

data/lib/{boxcar → boxcar_client}/notifier.rb

@@ -1,7 +1,7 @@
-module Boxcar
+module BoxcarClient
   class Notifier
     def self.push(user_data)
-      Agent.new(Boxcar.configuration.push_url, push_data(user_data)).push
+      Agent.new(BoxcarClient.configuration.push_url, push_data(user_data)).push
     end
 
     def self.push_data(user_data)
@@ -15,8 +15,8 @@ module Boxcar
     private
     def self.default_params
       {
-        'notification[icon_url]'         => Boxcar.configuration.icon_url,
-        'notification[from_screen_name]' => Boxcar.configuration.from_screen_name
+        'notification[icon_url]'         => BoxcarClient.configuration.icon_url,
+        'notification[from_screen_name]' => BoxcarClient.configuration.from_screen_name
       }
     end
   end

data/lib/boxcar_client/version.rb

@@ -0,0 +1,3 @@
+module BoxcarClient
+  VERSION = "0.0.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxcar_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Srihari, Unni
@@ -50,12 +50,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- boxcar.gemspec
-- lib/boxcar.rb
-- lib/boxcar/agent.rb
-- lib/boxcar/configuration.rb
-- lib/boxcar/notifier.rb
-- lib/boxcar/version.rb
+- boxcar_client.gemspec
+- lib/boxcar_client.rb
+- lib/boxcar_client/agent.rb
+- lib/boxcar_client/configuration.rb
+- lib/boxcar_client/notifier.rb
+- lib/boxcar_client/version.rb
 homepage: ''
 licenses:
 - MIT

data/lib/boxcar/version.rb

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