zero_push 1.0.0 → 1.1.0

data/Gemfile.lock

@@ -62,7 +62,6 @@ GEM
     thor (0.17.0)
     tilt (1.3.6)
     vcr (2.4.0)
-    yard (0.8.5.2)
 
 PLATFORMS
   ruby
@@ -75,5 +74,4 @@ DEPENDENCIES
   railties (~> 3.2.11)
   rake (~> 10.0.3)
   vcr (~> 2.4.0)
-  yard (~> 0.8.4)
   zero_push!

data/README.md

@@ -1,4 +1,4 @@
-[![ZeroPush](https://raw.github.com/SymmetricInfinity/zero_push/master/doc/zeropush-header.png)](https://zeropush.com)
+[![ZeroPush](https://raw.github.com/SymmetricInfinity/zero_push/master/zeropush-header.png)](https://zeropush.com)
 
 Build Status: [![Build Status](https://travis-ci.org/SymmetricInfinity/zero_push.png?branch=master)](https://travis-ci.org/SymmetricInfinity/zero_push)
 

data/lib/zero_push/client.rb

@@ -20,6 +20,14 @@ module ZeroPush
       client.post('/notify', params)
     end
 
+    # Registers a device token with the ZeroPush backend
+    #
+    # @params device_token
+    # @return response
+    def register(device_token)
+      client.post('/register', device_token: device_token)
+    end
+
     # the HTTP client configured for API requests
     #
     def client

data/lib/zero_push/version.rb

@@ -1,3 +1,3 @@
 module ZeroPush
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/fixtures/register.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.zeropush.com/register
+    body:
+      encoding: US-ASCII
+      string: device_token=abc
+    headers:
+      Authorization:
+      - Token token="test_token"
+      User-Agent:
+      - Faraday v0.8.7
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.2.6
+      date:
+      - Thu, 08 Aug 2013 23:50:40 GMT
+      content-type:
+      - application/json; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      status:
+      - 200 OK
+      strict-transport-security:
+      - max-age=31536000
+      x-ua-compatible:
+      - IE=Edge
+      etag:
+      - ! '"4548a4f1a11a241120f97a1c3737817a"'
+      cache-control:
+      - max-age=0, private, must-revalidate
+      set-cookie:
+      - _zero-push-session=BAh7BkkiD3Nlc3Npb25faWQGOgZFRkkiJWM0YWVlZjMxMWRlODM5OGI5MTk5MDQyZWZmNTc0YTg5BjsAVA%3D%3D--7832266b6f7ce258d10744496757e9d73192399d;
+        path=/; secure; HttpOnly
+      x-request-id:
+      - 09b0b1f839a3648dd1de9617e80f7583
+      x-runtime:
+      - '0.018914'
+      x-rack-cache:
+      - invalidate, pass
+      x-powered-by:
+      - Phusion Passenger 4.0.2
+    body:
+      encoding: US-ASCII
+      string: ! '{"message":"ok"}'
+    http_version: 
+  recorded_at: Thu, 08 Aug 2013 23:50:39 GMT
+recorded_with: VCR 2.4.0

data/spec/spec_helper.rb

@@ -11,8 +11,3 @@ VCR.configure do |c|
     match_requests_on: [:method, :uri, :headers]
   }
 end
-
-#TODO: remove this once Faraday 0.9.0 comes out
-require 'net/https'
-OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
-#Faraday.default_connection_options = {ssl: {verify: false}}

data/spec/zero_push_spec.rb

@@ -38,4 +38,19 @@ describe ZeroPush do
       response.status.must_equal 200
     end
   end
+
+  describe "/register" do
+    before do
+      VCR.insert_cassette "register"
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    it "should register the device" do
+      response = ZeroPush.register('abc')
+      response.status.must_equal 200
+    end
+  end
 end

data/zero_push.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["stefan.natchev@gmail.com", "adam.v.duke@gmail.com"]
   gem.summary       = %q{A gem for interacting with the ZeroPush API. (http://zeropush.com)}
   gem.description   = %q{ZeroPush is a simple service for sending iOS push notifications. (http://zeropush.com)}
-  gem.homepage      = "https://github.com/SymmetricInfinity/zero_push"
+  gem.homepage      = "https://zeropush.com"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -27,5 +27,4 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake',          '~> 10.0.3'
   gem.add_development_dependency 'railties',      '~> 3.2.11'
   gem.add_development_dependency 'vcr',           '~> 2.4.0'
-  gem.add_development_dependency 'yard',          '~> 0.8.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zero_push
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -140,22 +140,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.4.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.4
 description: ZeroPush is a simple service for sending iOS push notifications. (http://zeropush.com)
 email:
 - stefan.natchev@gmail.com
@@ -164,47 +148,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .autotest
 - .gitignore
 - .travis.yml
-- .yardoc/checksums
-- .yardoc/object_types
-- .yardoc/objects/root.dat
-- .yardoc/proxy_types
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- doc/ZeroPush.html
-- doc/ZeroPush/InstallGenerator.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
-- doc/zeropush-header.png
 - lib/generators/zero_push/install_generator.rb
 - lib/generators/zero_push/templates/zero_push.rb
 - lib/zero_push.rb
 - lib/zero_push/client.rb
 - lib/zero_push/version.rb
 - spec/fixtures/notify.yml
+- spec/fixtures/register.yml
 - spec/fixtures/verify_credentials.yml
 - spec/generator_spec.rb
 - spec/spec_helper.rb
 - spec/zero_push_spec.rb
 - zero_push.gemspec
-homepage: https://github.com/SymmetricInfinity/zero_push
+- zeropush-header.png
+homepage: https://zeropush.com
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -230,6 +194,7 @@ specification_version: 3
 summary: A gem for interacting with the ZeroPush API. (http://zeropush.com)
 test_files:
 - spec/fixtures/notify.yml
+- spec/fixtures/register.yml
 - spec/fixtures/verify_credentials.yml
 - spec/generator_spec.rb
 - spec/spec_helper.rb

data/.autotest

@@ -1,25 +0,0 @@
-# -*- ruby -*-
-
-require "autotest/restart"
-
-# Autotest.add_hook :initialize do |at|
-#   at.testlib = "minitest/unit"
-#
-#   at.extra_files << "../some/external/dependency.rb"
-#
-#   at.libs << ":../some/external"
-#
-#   at.add_exception "vendor"
-#
-#   at.add_mapping(/dependency.rb/) do |f, _|
-#     at.files_matching(/test_.*rb$/)
-#   end
-#
-#   %w(TestA TestB).each do |klass|
-#     at.extra_class_map[klass] = "test/test_misc.rb"
-#   end
-# end
-
-# Autotest.add_hook :run_command do |at|
-#   system "rake build"
-# end

data/.yardoc/checksums

@@ -1,5 +0,0 @@
-lib/zero_push.rb 4e26ee56b254c4e6c4e4e94fc97f85847af1118d
-lib/zero_push/client.rb 320cb3888492b6ee1145baaa28e48fc5807dacfe
-lib/zero_push/version.rb 5e2505a1d0944efdf5713ab88a4c888dea936503
-lib/generators/zero_push/install_generator.rb 35d1c52c5657e75a1a0d109af66974d28dd922df
-lib/generators/zero_push/templates/zero_push.rb 8727f64fb299b7a89d0526acfacb3eaef546227e

data/doc/ZeroPush.html

@@ -1,482 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Module: ZeroPush
-  
-    &mdash; Documentation by YARD 0.8.5.2
-  
-</title>
-
-  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
-
-  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
-
-<script type="text/javascript" charset="utf-8">
-  hasFrames = window.top.frames.main ? true : false;
-  relpath = '';
-  framesUrl = "frames.html#!" + escape(window.location.href);
-</script>
-
-
-  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-
-  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-
-
-  </head>
-  <body>
-    <div id="header">
-      <div id="menu">
-  
-    <a href="_index.html">Index (Z)</a> &raquo;
-    
-    
-    <span class="title">ZeroPush</span>
-  
-
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-
-      <div id="search">
-  
-    <a class="full_list_link" id="class_list_link"
-        href="class_list.html">
-      Class List
-    </a>
-  
-    <a class="full_list_link" id="method_list_link"
-        href="method_list.html">
-      Method List
-    </a>
-  
-    <a class="full_list_link" id="file_list_link"
-        href="file_list.html">
-      File List
-    </a>
-  
-</div>
-      <div class="clear"></div>
-    </div>
-
-    <iframe id="search_frame"></iframe>
-
-    <div id="content"><h1>Module: ZeroPush
-  
-  
-  
-</h1>
-
-<dl class="box">
-  
-  
-    
-  
-    
-  
-  
-  
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/zero_push/client.rb<span class="defines">,<br />
-  lib/zero_push/version.rb,<br /> lib/generators/zero_push/install_generator.rb</span>
-</dd>
-  
-</dl>
-<div class="clear"></div>
-
-<h2>Defined Under Namespace</h2>
-<p class="children">
-  
-    
-  
-    
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="ZeroPush/InstallGenerator.html" title="ZeroPush::InstallGenerator (class)">InstallGenerator</a></span>
-    
-  
-</p>
-
-  <h2>Constant Summary</h2>
-  
-    <dl class="constants">
-      
-        <dt id="URL-constant" class="">URL =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>https://api.zeropush.com</span><span class='tstring_end'>&quot;</span></span></pre></dd>
-      
-        <dt id="VERSION-constant" class="">VERSION =
-          
-        </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.5</span><span class='tstring_end'>&quot;</span></span></pre></dd>
-      
-    </dl>
-  
-
-
-
-
-  <h2>Class Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
-  <ul class="summary">
-    
-      <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#auth_token-class_method" title="auth_token (class method)">+ (Object) <strong>auth_token</strong> </a>
-    
-
-    
-  </span>
-  
-  
-  
-    
-    
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>
-<p>Returns the value of attribute auth_token.</p>
-</div></span>
-  
-</li>
-
-    
-  </ul>
-
-
-
-
-  
-    <h2>
-      Class Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-
-    <ul class="summary">
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#client-class_method" title="client (class method)">+ (Object) <strong>client</strong> </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>
-<p>the HTTP client configured for API requests.</p>
-</div></span>
-  
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#notify-class_method" title="notify (class method)">+ (Object) <strong>notify</strong>(params) </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>
-<p>Sends a notification to the list of devices.</p>
-</div></span>
-  
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#verify_credentials-class_method" title="verify_credentials (class method)">+ (Boolean) <strong>verify_credentials</strong> </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>
-<p>verifies credentials.</p>
-</div></span>
-  
-</li>
-
-      
-    </ul>
-  
-
-
-  <div id="class_attr_details" class="attr_details">
-    <h2>Class Attribute Details</h2>
-    
-      
-      <span id="auth_token=-class_method"></span>
-      <div class="method_details first">
-  <h3 class="signature first" id="auth_token-class_method">
-  
-    + (<tt>Object</tt>) <strong>auth_token</strong> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    
-<p>Returns the value of attribute auth_token</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-5
-6
-7</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/zero_push/client.rb', line 5</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_auth_token'>auth_token</span>
-  <span class='ivar'>@auth_token</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-  </div>
-
-
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-
-    
-      <div class="method_details first">
-  <h3 class="signature first" id="client-class_method">
-  
-    + (<tt>Object</tt>) <strong>client</strong> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    
-<p>the HTTP client configured for API requests</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-25
-26
-27
-28
-29
-30
-31</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/zero_push/client.rb', line 25</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
-  <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>url:</span> <span class='const'>URL</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
-    <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_token_auth'>token_auth</span>  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_auth_token'>auth_token</span>
-    <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span>     <span class='symbol'>:url_encoded</span>            <span class='comment'># form-encode POST params
-</span>    <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span>     <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_default_adapter'>default_adapter</span> <span class='comment'># Net::HTTP
-</span>  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-      <div class="method_details ">
-  <h3 class="signature " id="notify-class_method">
-  
-    + (<tt>Object</tt>) <strong>notify</strong>(params) 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    
-<p>Sends a notification to the list of devices</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-  
-    <li>
-      
-        <span class='name'>params</span>
-      
-      
-        <span class='type'>(<tt>Hash</tt>)</span>
-      
-      
-      
-    </li>
-  
-</ul>
-
-<p class="tag_title">Returns:</p>
-<ul class="return">
-  
-    <li>
-      
-      
-        <span class='type'></span>
-      
-      
-      
-        
-        <div class='inline'>
-<p>response</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-19
-20
-21</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/zero_push/client.rb', line 19</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_notify'>notify</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/notify</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-      <div class="method_details ">
-  <h3 class="signature " id="verify_credentials-class_method">
-  
-    + (<tt>Boolean</tt>) <strong>verify_credentials</strong> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    
-<p>verifies credentials</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-<p class="tag_title">Returns:</p>
-<ul class="return">
-  
-    <li>
-      
-      
-        <span class='type'>(<tt>Boolean</tt>)</span>
-      
-      
-      
-    </li>
-  
-</ul>
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-10
-11
-12
-13</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/zero_push/client.rb', line 10</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_verify_credentials'>verify_credentials</span>
-  <span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/verify_credentials</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span> <span class='op'>==</span> <span class='int'>200</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-  </div>
-
-</div>
-
-    <div id="footer">
-  Generated on Sat Jun  8 14:43:46 2013 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.5.2 (ruby-1.9.3).
-</div>
-
-  </body>
-</html>