roost 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +48 -0
- data/Rakefile +1 -0
- data/lib/roost.rb +39 -0
- data/lib/roost/version.rb +3 -0
- data/roost.gemspec +24 -0
- metadata +94 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 83c6b1a634dccf3e95592141e87f70d2f0929c06
|
4
|
+
data.tar.gz: 582654be2a2bd1be655e5629a6e8b7bf8fcf7f49
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 1bf6d67507daf4af90977176c7fb2c9f5cf698bc6faed0c99364fc7362e6f15cc72780eae041df5c6bf227b399eadf7651428942bdc5e37de10b5bf7861c46e0
|
7
|
+
data.tar.gz: b4725f610a3e599b12f66d269035c4d6e4ccac14aaa9074d7819ebd27c9040b86b09545d04d33c8a60da8ca2c8e9484a0624daa90aadc68c04c98996d10db1eb
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 Rick Byington
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
# Roost
|
2
|
+
|
3
|
+
This is the official Ruby GEM for the Roost API.
|
4
|
+
|
5
|
+
Roost is the easy way to send Safari Push Notifications to your website visitors.
|
6
|
+
Desktop Push Notifications provide a new marketing channel to drive visitors back to your site.
|
7
|
+
With Safari on OS X Mavericks, visitors receive notifications in the top right corner of their computer screen.
|
8
|
+
This ‘gentle’ touch is great for status updates or trending information. To learn more see roost.me
|
9
|
+
|
10
|
+
|
11
|
+
## Installation
|
12
|
+
|
13
|
+
Add this line to your application's Gemfile:
|
14
|
+
|
15
|
+
gem 'roost'
|
16
|
+
|
17
|
+
And then execute:
|
18
|
+
|
19
|
+
$ bundle
|
20
|
+
|
21
|
+
Or install it yourself as:
|
22
|
+
|
23
|
+
$ gem install roost
|
24
|
+
|
25
|
+
## Usage
|
26
|
+
|
27
|
+
To send notifications you first need to create an account on roost.me.
|
28
|
+
|
29
|
+
Then make sure you have ENV["ROOST_APPKEY"] and ENV["ROOST_APPSECRET"] set. These can be found in the Roost.me Dashboard under settings.
|
30
|
+
If you are using the Heroku Add-On these are already configured for you.
|
31
|
+
|
32
|
+
Once you have some registered Safari visitors on your site you can use the following code to send them a message.
|
33
|
+
|
34
|
+
response = Roost::API.send({alert:'Welcome to Roost',url:'http://roost.me'})
|
35
|
+
if response['success'] == true
|
36
|
+
..success..
|
37
|
+
else
|
38
|
+
..failure..
|
39
|
+
end
|
40
|
+
|
41
|
+
|
42
|
+
## Contributing
|
43
|
+
|
44
|
+
1. Fork it ( http://github.com/<my-github-username>/roost/fork )
|
45
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
46
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
47
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
48
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/lib/roost.rb
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
require "roost/version"
|
2
|
+
require 'json'
|
3
|
+
|
4
|
+
module Roost
|
5
|
+
class API
|
6
|
+
def self.send(opts)
|
7
|
+
opts = opts||{}
|
8
|
+
|
9
|
+
key = opts[:app_key]||ENV["ROOST_APPKEY"]
|
10
|
+
secret = opts[:app_secret]||ENV["ROOST_APPSECRET"]
|
11
|
+
|
12
|
+
raise "ROOST_APPKEY and ROOST_APPSECRET must be set as environment variables." if(key.nil? || key.empty? || secret.nil? || secret.empty?)
|
13
|
+
raise "opts.alert must be given." if opts[:alert].nil? || opts[:alert].empty?
|
14
|
+
raise "opts.url must be given." if opts[:url].nil? || opts[:url].empty?
|
15
|
+
|
16
|
+
uri = URI.parse("https://get.roost.me/api/push")
|
17
|
+
http = Net::HTTP.new(uri.host, uri.port)
|
18
|
+
http.use_ssl = true
|
19
|
+
request = Net::HTTP::Post.new(uri.path, initheader = {'Content-Type' =>'application/json'})
|
20
|
+
request.basic_auth key,secret
|
21
|
+
|
22
|
+
request.body = {
|
23
|
+
alert:opts[:alert],
|
24
|
+
url:opts[:url]
|
25
|
+
}.to_json
|
26
|
+
|
27
|
+
response = http.request(request)
|
28
|
+
if response.code == "200"
|
29
|
+
return JSON.parse(response.body)
|
30
|
+
else
|
31
|
+
return {
|
32
|
+
"success"=>false,
|
33
|
+
"message"=>response.message,
|
34
|
+
"code"=>response.code
|
35
|
+
}
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
data/roost.gemspec
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'roost/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "roost"
|
8
|
+
spec.version = Roost::VERSION
|
9
|
+
spec.authors = ["Rick Byington"]
|
10
|
+
spec.email = ["rick@byingtondesign.com"]
|
11
|
+
spec.summary = %q{Roost.me Ruby API library.}
|
12
|
+
spec.description = %q{}
|
13
|
+
spec.homepage = ""
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.5"
|
22
|
+
spec.add_development_dependency "rake"
|
23
|
+
spec.add_development_dependency "rspec", "~> 2.6"
|
24
|
+
end
|
metadata
ADDED
@@ -0,0 +1,94 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: roost
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Rick Byington
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-04-01 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.5'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.5'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '2.6'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '2.6'
|
55
|
+
description: ''
|
56
|
+
email:
|
57
|
+
- rick@byingtondesign.com
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- ".gitignore"
|
63
|
+
- Gemfile
|
64
|
+
- LICENSE.txt
|
65
|
+
- README.md
|
66
|
+
- Rakefile
|
67
|
+
- lib/roost.rb
|
68
|
+
- lib/roost/version.rb
|
69
|
+
- roost.gemspec
|
70
|
+
homepage: ''
|
71
|
+
licenses:
|
72
|
+
- MIT
|
73
|
+
metadata: {}
|
74
|
+
post_install_message:
|
75
|
+
rdoc_options: []
|
76
|
+
require_paths:
|
77
|
+
- lib
|
78
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
84
|
+
requirements:
|
85
|
+
- - ">="
|
86
|
+
- !ruby/object:Gem::Version
|
87
|
+
version: '0'
|
88
|
+
requirements: []
|
89
|
+
rubyforge_project:
|
90
|
+
rubygems_version: 2.2.1
|
91
|
+
signing_key:
|
92
|
+
specification_version: 4
|
93
|
+
summary: Roost.me Ruby API library.
|
94
|
+
test_files: []
|