faast 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f96e92940ec6183438d43391cb63f11a747bc68e
+  data.tar.gz: 59a1539092c2769659be16519eac13431a8b622a
+SHA512:
+  metadata.gz: 3dab61332d6dc16125a4116bc64450caf613e8389ee155651d035a60034e3ab26fe03ef53d7525741d23611833587dc3edb8230f5500305a32109aa773ce7bad
+  data.tar.gz: 2a439ed6e059f5cdc95c37baf4e3f30cded5ac2842458fdaaa2015db387c6903a561a1a971dbde7af55bd5dd639743e531548ad0f39f1e7ac71115b3ed4e7ede

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+##### v0.1.0 (2013-06-25) #####
+* fixed: setting user credentials at the `Notification` level
+* fixed: issues with Ruby 1.8 and 1.9 related to HTTPS support
+
+##### v0.0.1 (2013-06-09) #####
+* initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rake'
+  gem 'coveralls'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Chris Lucas <chris@chrisjlucas.com>
+
+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/README.md

@@ -0,0 +1,35 @@
+[![Coverage Status](https://coveralls.io/repos/cjlucas/ruby-faast/badge.png)](https://coveralls.io/r/cjlucas/ruby-faast)
+[![Build Status](https://travis-ci.org/cjlucas/ruby-faast.png?branch=master)](https://travis-ci.org/cjlucas/ruby-faast)
+
+This is a simple library for the [Faast](http://www.faast.io/) push notification service.
+
+Currently only the REST API is supported.
+
+---
+## Synopsis ##
+
+```ruby
+require 'faast'
+
+# user credentials can be set at the module level or directly in the Notification instance
+Faast.user_credentials = 'api_key'
+
+# create a notification instance
+notification = Faast::Notification.new
+
+notification.title    = 'This is the title'
+notification.message  = 'This is the message'
+notfication.icon_url  = 'https://github.com/favicon.ico'
+
+notification.send
+# => #<Net::HTTPOK 200 OK readbody=true>
+
+# or use the block interface (this is prefered)
+resp = Faast::Notification.send do |notification|
+  notification.title    = 'This is the title'
+  notification.message  = 'This is the message'
+  notfication.icon_url  = 'https://github.com/favicon.ico'
+end
+
+resp
+# => #<Net::HTTPOK 200 OK readbody=true>

data/Rakefile

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+require 'rake/testtask'
+
+require 'faast/version'
+
+task :default => [:test]
+
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/test_*.rb']
+    t.verbose = true
+  end
+end
+
+task :build do
+  system 'gem build faast.gemspec'
+end
+
+task :release => :build do
+  system "gem push faast-#{Faast::VERSION}.gem"
+end
+
+task :clean do
+  system 'rm -f *.gem'
+end

data/faast.gemspec

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+require 'faast/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'faast'
+  s.version     = Faast::VERSION
+  s.summary     = 'A ruby library for the Faast push notification service'
+  #s.description = <<-EOF
+  #EOF
+  s.authors     = ['Chris Lucas']
+  s.email       = ['chris@chrisjlucas.com']
+  s.homepage    = 'https://github.com/cjlucas/ruby-faast'
+  s.license     = 'MIT'
+  s.files       = `git ls-files | egrep '^[^\.]'`.split(/\r?\n/)
+  s.test_files  = s.files.select { |f| f.match(/^test\/.*\.rb$/) }
+  s.platform    = Gem::Platform::RUBY
+
+  s.add_development_dependency('rake')
+end

data/lib/faast.rb

@@ -0,0 +1,98 @@
+require 'net/http'
+
+module Faast
+  URL = 'https://www.appnotifications.com/account/notifications.json'
+  
+  class << self
+    attr_accessor :user_credentials
+  end
+
+  class Notification
+    attr_accessor :user_credentials
+    attr_accessor :message
+    attr_accessor :long_message
+    attr_accessor :long_message_preview
+    attr_accessor :title
+    attr_accessor :subtitle
+    attr_accessor :message_level
+    attr_accessor :silent
+    attr_accessor :action_loc_key
+    attr_accessor :icon_url
+    attr_accessor :sound
+
+    simple_fields = [
+      :message,
+      :long_message,
+      :long_message_preview,
+      :title,
+      :subtitle,
+      :action_loc_key,
+      :icon_url,
+    ]
+
+    def initialize
+      @data = {}
+      self.user_credentials = Faast.user_credentials
+    end
+
+    def user_credentials=(user_credentials)
+      @user_credentials = user_credentials
+      @data['user_credentials'] = user_credentials
+    end
+
+    def message_level=(message_level)
+      self.class.assert_num_in_range(message_level, -2..2)
+      @message_level = message_level
+      @data['notification[message_level]'] = message_level
+    end
+
+    def silent=(silent)
+      @silent = silent
+      @data['notification[silent]'] = silent ? 1 : 0
+    end
+
+    def sound=(sound)
+      self.class.assert_num_in_range(sound, 1..40)
+      @sound = sound
+      @data['notification[sound]'] = sound
+    end
+
+    def send
+      uri = URI(URL)
+      
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      
+      req = Net::HTTP::Post.new(uri.to_s)
+      req.set_form_data(@data)
+      
+      http.request(req)
+    end
+
+    def self.send
+      if block_given?
+        notif = self.new
+        yield notif
+        notif.send
+      end
+    end
+
+    # create setters for simple fields
+    simple_fields.each do |field|
+      define_method("#{field}=") do |input|
+        ivar = "@#{field}"
+        url_param = "notification[#{field}]"
+        instance_variable_set(ivar, input)
+        @data[url_param] = input
+      end
+    end
+    
+    private
+
+    def self.assert_num_in_range(num, range)
+      unless range.include?(num)
+        raise ArgumentError, "Expected number between #{range}"
+      end
+    end
+  end
+end

data/lib/faast/version.rb

@@ -0,0 +1,9 @@
+module Faast
+  class Version
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+  end
+
+  VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].join('.')
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler.require(:test)
+
+require 'test/unit'
+require 'coveralls'
+
+Coveralls.wear!

data/test/test_post.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+require 'faast'
+
+class TestPost < Test::Unit::TestCase
+  def test_post_no_api_key
+    resp = Faast::Notification.send { |notification| }
+    assert_block { resp.is_a?(Net::HTTPUnauthorized) }
+  end
+
+  def test_post_with_api_key
+    user_credentials_file = File.expand_path('../user_creds.txt', __FILE__)
+    
+    if File.exists?(user_credentials_file)
+      resp = Faast::Notification.send do |notification|
+        notification.user_credentials = File.read(user_credentials_file).strip
+        notification.title = '[ruby-faast] this is the title'
+        notification.message = '[ruby-faast] this is the message'
+      end
+
+      assert_block { resp.is_a?(Net::HTTPSuccess) }
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: faast
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Lucas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- chris@chrisjlucas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- faast.gemspec
+- lib/faast.rb
+- lib/faast/version.rb
+- test/test_helper.rb
+- test/test_post.rb
+homepage: https://github.com/cjlucas/ruby-faast
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: A ruby library for the Faast push notification service
+test_files:
+- test/test_helper.rb
+- test/test_post.rb