pharos 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +24 -0
- data/Gemfile +2 -0
- data/Rakefile +11 -0
- data/lib/pharos.rb +44 -0
- data/lib/pharos/channel.rb +34 -0
- data/lib/pharos/client.rb +27 -0
- data/pharos.gemspec +27 -0
- metadata +170 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/Rakefile
ADDED
data/lib/pharos.rb
ADDED
@@ -0,0 +1,44 @@
|
|
1
|
+
require 'uri'
|
2
|
+
require 'forwardable'
|
3
|
+
|
4
|
+
require 'pharos/client'
|
5
|
+
|
6
|
+
# Used for configuring API credentials and creating Channel objects
|
7
|
+
#
|
8
|
+
module Pharos
|
9
|
+
|
10
|
+
class Error < RuntimeError; end
|
11
|
+
class AuthenticationError < Error; end
|
12
|
+
class ConfigurationError < Error; end
|
13
|
+
class HTTPError < Error; attr_accessor :original_error; end
|
14
|
+
|
15
|
+
class << self
|
16
|
+
extend Forwardable
|
17
|
+
|
18
|
+
def_delegators :default_client, :base_uri, :secret
|
19
|
+
def_delegators :default_client, :base_uri=, :secret=
|
20
|
+
|
21
|
+
# Return a channel by name
|
22
|
+
#
|
23
|
+
# @example
|
24
|
+
# Pharos['my-channel']
|
25
|
+
# @return [Channel]
|
26
|
+
# @raise [ConfigurationError] unless key, secret and app_id have been
|
27
|
+
# configured
|
28
|
+
def [](channel_name)
|
29
|
+
begin
|
30
|
+
default_client[channel_name]
|
31
|
+
rescue ConfigurationError
|
32
|
+
raise ConfigurationError, 'Missing configuration: please check that Pharos.secret is configured.'
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
private
|
37
|
+
|
38
|
+
def default_client
|
39
|
+
@default_client ||= Pharos::Client.new
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
require 'pharos/channel'
|
@@ -0,0 +1,34 @@
|
|
1
|
+
require 'httparty'
|
2
|
+
require 'multi_json'
|
3
|
+
|
4
|
+
module Pharos
|
5
|
+
class Channel
|
6
|
+
|
7
|
+
include HTTParty
|
8
|
+
|
9
|
+
attr_reader :name
|
10
|
+
|
11
|
+
def initialize(name, base_uri, client = Pharos)
|
12
|
+
@name = name
|
13
|
+
@path = base_uri + "/push/#{name}/"
|
14
|
+
@client = client
|
15
|
+
@auth = { username: 'pharos', password: client.secret }
|
16
|
+
end
|
17
|
+
|
18
|
+
def push(receivers, data)
|
19
|
+
body = case data
|
20
|
+
when String
|
21
|
+
data # In this case we send a javascript instruction
|
22
|
+
else
|
23
|
+
begin
|
24
|
+
MultiJson.encode(data)
|
25
|
+
rescue MultiJson::DecodeError => e
|
26
|
+
raise e
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
options = { body: { to: receivers, message: body }, basic_auth: @auth}
|
31
|
+
self.class.post(@path, options)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
module Pharos
|
2
|
+
class Client
|
3
|
+
|
4
|
+
attr_accessor :base_uri, :secret
|
5
|
+
|
6
|
+
def initialize(options = {})
|
7
|
+
options = {
|
8
|
+
:base_uri => 'http://pharos.saloon.io',
|
9
|
+
}.merge(options)
|
10
|
+
@base_uri, @secret = options.values_at(
|
11
|
+
:base_uri, :secret
|
12
|
+
)
|
13
|
+
end
|
14
|
+
|
15
|
+
def [](channel_name)
|
16
|
+
raise ConfigurationError, 'Missing client configuration: please check that secret is configured.' unless configured?
|
17
|
+
@channels ||= {}
|
18
|
+
@channels[channel_name.to_s] ||= Channel.new(channel_name, base_uri, self)
|
19
|
+
end
|
20
|
+
|
21
|
+
private
|
22
|
+
|
23
|
+
def configured?
|
24
|
+
base_uri && secret
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
data/pharos.gemspec
ADDED
@@ -0,0 +1,27 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
$:.push File.expand_path("../lib", __FILE__)
|
3
|
+
|
4
|
+
Gem::Specification.new do |s|
|
5
|
+
s.name = "pharos"
|
6
|
+
s.version = "0.1.0"
|
7
|
+
s.platform = Gem::Platform::RUBY
|
8
|
+
s.authors = ["Saloon"]
|
9
|
+
s.email = ["pharos@saloon.io"]
|
10
|
+
s.homepage = "http://github.com/pharos/pharos.rb"
|
11
|
+
s.summary = %q{Phaor API client}
|
12
|
+
s.description = %q{Wrapper for Pharos REST API}
|
13
|
+
|
14
|
+
s.add_dependency "multi_json", "~> 1.0"
|
15
|
+
s.add_dependency "httparty"
|
16
|
+
|
17
|
+
s.add_development_dependency "rspec", "~> 2.0"
|
18
|
+
s.add_development_dependency "webmock"
|
19
|
+
s.add_development_dependency "em-http-request", "~> 1.0.0"
|
20
|
+
s.add_development_dependency "rake"
|
21
|
+
s.add_development_dependency "rack"
|
22
|
+
|
23
|
+
s.files = `git ls-files`.split("\n")
|
24
|
+
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
25
|
+
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
26
|
+
s.require_paths = ["lib"]
|
27
|
+
end
|
metadata
ADDED
@@ -0,0 +1,170 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: pharos
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Saloon
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2012-06-21 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: multi_json
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '1.0'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '1.0'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: httparty
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
type: :runtime
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '0'
|
46
|
+
- !ruby/object:Gem::Dependency
|
47
|
+
name: rspec
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
none: false
|
50
|
+
requirements:
|
51
|
+
- - ~>
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '2.0'
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ~>
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '2.0'
|
62
|
+
- !ruby/object:Gem::Dependency
|
63
|
+
name: webmock
|
64
|
+
requirement: !ruby/object:Gem::Requirement
|
65
|
+
none: false
|
66
|
+
requirements:
|
67
|
+
- - ! '>='
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0'
|
70
|
+
type: :development
|
71
|
+
prerelease: false
|
72
|
+
version_requirements: !ruby/object:Gem::Requirement
|
73
|
+
none: false
|
74
|
+
requirements:
|
75
|
+
- - ! '>='
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
version: '0'
|
78
|
+
- !ruby/object:Gem::Dependency
|
79
|
+
name: em-http-request
|
80
|
+
requirement: !ruby/object:Gem::Requirement
|
81
|
+
none: false
|
82
|
+
requirements:
|
83
|
+
- - ~>
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: 1.0.0
|
86
|
+
type: :development
|
87
|
+
prerelease: false
|
88
|
+
version_requirements: !ruby/object:Gem::Requirement
|
89
|
+
none: false
|
90
|
+
requirements:
|
91
|
+
- - ~>
|
92
|
+
- !ruby/object:Gem::Version
|
93
|
+
version: 1.0.0
|
94
|
+
- !ruby/object:Gem::Dependency
|
95
|
+
name: rake
|
96
|
+
requirement: !ruby/object:Gem::Requirement
|
97
|
+
none: false
|
98
|
+
requirements:
|
99
|
+
- - ! '>='
|
100
|
+
- !ruby/object:Gem::Version
|
101
|
+
version: '0'
|
102
|
+
type: :development
|
103
|
+
prerelease: false
|
104
|
+
version_requirements: !ruby/object:Gem::Requirement
|
105
|
+
none: false
|
106
|
+
requirements:
|
107
|
+
- - ! '>='
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '0'
|
110
|
+
- !ruby/object:Gem::Dependency
|
111
|
+
name: rack
|
112
|
+
requirement: !ruby/object:Gem::Requirement
|
113
|
+
none: false
|
114
|
+
requirements:
|
115
|
+
- - ! '>='
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
none: false
|
122
|
+
requirements:
|
123
|
+
- - ! '>='
|
124
|
+
- !ruby/object:Gem::Version
|
125
|
+
version: '0'
|
126
|
+
description: Wrapper for Pharos REST API
|
127
|
+
email:
|
128
|
+
- pharos@saloon.io
|
129
|
+
executables: []
|
130
|
+
extensions: []
|
131
|
+
extra_rdoc_files: []
|
132
|
+
files:
|
133
|
+
- .gitignore
|
134
|
+
- Gemfile
|
135
|
+
- Rakefile
|
136
|
+
- lib/pharos.rb
|
137
|
+
- lib/pharos/channel.rb
|
138
|
+
- lib/pharos/client.rb
|
139
|
+
- pharos.gemspec
|
140
|
+
homepage: http://github.com/pharos/pharos.rb
|
141
|
+
licenses: []
|
142
|
+
post_install_message:
|
143
|
+
rdoc_options: []
|
144
|
+
require_paths:
|
145
|
+
- lib
|
146
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
147
|
+
none: false
|
148
|
+
requirements:
|
149
|
+
- - ! '>='
|
150
|
+
- !ruby/object:Gem::Version
|
151
|
+
version: '0'
|
152
|
+
segments:
|
153
|
+
- 0
|
154
|
+
hash: -3632834794260027269
|
155
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
156
|
+
none: false
|
157
|
+
requirements:
|
158
|
+
- - ! '>='
|
159
|
+
- !ruby/object:Gem::Version
|
160
|
+
version: '0'
|
161
|
+
segments:
|
162
|
+
- 0
|
163
|
+
hash: -3632834794260027269
|
164
|
+
requirements: []
|
165
|
+
rubyforge_project:
|
166
|
+
rubygems_version: 1.8.24
|
167
|
+
signing_key:
|
168
|
+
specification_version: 3
|
169
|
+
summary: Phaor API client
|
170
|
+
test_files: []
|