appboard 1.0.1 → 1.0.2
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/README.md +135 -0
- data/lib/appboard/version.rb +1 -1
- data/lib/appboard.rb +3 -3
- metadata +6 -6
- data/README +0 -0
data/README.md
ADDED
@@ -0,0 +1,135 @@
|
|
1
|
+
appboard
|
2
|
+
===========
|
3
|
+
[appboard](http://appboard.me/) is real-time dashboard for your application and business.
|
4
|
+
|
5
|
+
Dashboards tell people what's happening and should help them immediately recognize what needs their attention. Just like the dashboard of a car, which provides easily monitored measures of speed, remaining fuel, oil level, battery strength, engine trouble, and so on, a application and business information dashboard provides an overview that can be assimilated quickly.
|
6
|
+
|
7
|
+
Further reading:
|
8
|
+
|
9
|
+
* [Home page](http://appboard.me/)
|
10
|
+
* [The essential documentation](http://appboard.me/docs)
|
11
|
+
* [List of available widgets](http://appboard.me/docs/widgets)
|
12
|
+
|
13
|
+
|
14
|
+
NOTE: We are currently in private beta. Please let me know (eugene@appboard.me) if you'd like an invite.
|
15
|
+
|
16
|
+
|
17
|
+
Gem Installation
|
18
|
+
----------------
|
19
|
+
|
20
|
+
Install the heroku gem if you haven't already:
|
21
|
+
|
22
|
+
$ gem install appboard
|
23
|
+
|
24
|
+
Note that appboard does not require ActiveSupport or Rails. You can safely use it in your own Ruby projects.
|
25
|
+
|
26
|
+
Local setup
|
27
|
+
-----------
|
28
|
+
|
29
|
+
Before using appboard in your application, you need to let appboard know your API key, you do this (e.g. in an initializer):
|
30
|
+
|
31
|
+
require 'rubygems'
|
32
|
+
require 'appboard'
|
33
|
+
|
34
|
+
Appboard.settings ({ :apiKey => "abcd1234" })
|
35
|
+
|
36
|
+
or you could define API key in call block:
|
37
|
+
|
38
|
+
require 'rubygems'
|
39
|
+
require 'appboard'
|
40
|
+
|
41
|
+
Appboard.pub {
|
42
|
+
apiKey "abcd1234"
|
43
|
+
|
44
|
+
widget('some name here') {
|
45
|
+
uid "abcd1234"
|
46
|
+
|
47
|
+
data do {
|
48
|
+
# Data is here
|
49
|
+
}
|
50
|
+
}
|
51
|
+
}
|
52
|
+
|
53
|
+
|
54
|
+
Deploying to Heroku
|
55
|
+
-------------------
|
56
|
+
To use [appboard](http://appboard.me/) on Heroku, install the appboard add-on:
|
57
|
+
|
58
|
+
$ heroku addons:add appboard
|
59
|
+
|
60
|
+
|
61
|
+
You can also do this from the Resources section of your application's configuration page on Heroku.
|
62
|
+
|
63
|
+
This will automatically create you an appboard.me account and create an default dashboard, and fill will set the Heroku configuration variables variables ENV['APPBOARD_API_URL'] and ENV['APPBOARD_API_KEY'].
|
64
|
+
|
65
|
+
|
66
|
+
Usage
|
67
|
+
-----
|
68
|
+
|
69
|
+
There is several options how you could use API:
|
70
|
+
|
71
|
+
*publish each widget separately*
|
72
|
+
|
73
|
+
require 'rubygems'
|
74
|
+
require 'appboard'
|
75
|
+
|
76
|
+
Appboard.settings ({ :apiKey => "abcd1234" })
|
77
|
+
|
78
|
+
widget = Appboard.widget('some name here') {
|
79
|
+
uid "abcd1234"
|
80
|
+
|
81
|
+
data do {
|
82
|
+
# Data is here
|
83
|
+
}
|
84
|
+
}
|
85
|
+
|
86
|
+
response = widget.pub # publish data on appboard.me
|
87
|
+
|
88
|
+
response.success? # => true
|
89
|
+
response.code # => 200
|
90
|
+
|
91
|
+
|
92
|
+
*publish few widgets at once*
|
93
|
+
|
94
|
+
require 'rubygems'
|
95
|
+
require 'appboard'
|
96
|
+
|
97
|
+
Appboard.settings ({ :apiKey => "abcd1234" })
|
98
|
+
|
99
|
+
|
100
|
+
Appboard.pub {
|
101
|
+
apiKey "abcd1234"
|
102
|
+
|
103
|
+
widget('widget1') {
|
104
|
+
uid "abcd1234"
|
105
|
+
|
106
|
+
data do {
|
107
|
+
# Data is here
|
108
|
+
}
|
109
|
+
}
|
110
|
+
widget('widget2') {
|
111
|
+
uid "abcd4321"
|
112
|
+
|
113
|
+
data do {
|
114
|
+
# Data is here
|
115
|
+
}
|
116
|
+
}
|
117
|
+
}
|
118
|
+
|
119
|
+
|
120
|
+
widget = Appboard.widget('widget1') # after you could access widget by name
|
121
|
+
|
122
|
+
|
123
|
+
NOTE: Don't forget to specify your apiKey and widget identifier.
|
124
|
+
|
125
|
+
|
126
|
+
### What Should My Request Look Like? ###
|
127
|
+
|
128
|
+
Each widget has its own page on [our documentation](http://appboard.me/docs). That page contains all the information you need in order to start working with the widget, including descriptions of data model (a piece that represents some kind of data).
|
129
|
+
|
130
|
+
Copyright
|
131
|
+
-----------
|
132
|
+
|
133
|
+
Copyright (c) 2011 appboard.me. See LICENSE for details.
|
134
|
+
|
135
|
+
|
data/lib/appboard/version.rb
CHANGED
data/lib/appboard.rb
CHANGED
@@ -23,9 +23,9 @@ module Appboard
|
|
23
23
|
@apiKey
|
24
24
|
end
|
25
25
|
|
26
|
-
#
|
26
|
+
# Publish all defined widgets in block
|
27
27
|
#
|
28
|
-
# appboard.
|
28
|
+
# appboard.pub {
|
29
29
|
# # Do stuff in here
|
30
30
|
# }
|
31
31
|
#
|
@@ -35,7 +35,7 @@ module Appboard
|
|
35
35
|
#
|
36
36
|
# Refer to default config below for how to set these as defaults
|
37
37
|
#
|
38
|
-
def
|
38
|
+
def pub(options = {}, &block)
|
39
39
|
@config = settings.update(options)
|
40
40
|
|
41
41
|
self.instance_eval(&block) if block_given?
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: appboard
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
hash:
|
4
|
+
hash: 19
|
5
5
|
prerelease: false
|
6
6
|
segments:
|
7
7
|
- 1
|
8
8
|
- 0
|
9
|
-
-
|
10
|
-
version: 1.0.
|
9
|
+
- 2
|
10
|
+
version: 1.0.2
|
11
11
|
platform: ruby
|
12
12
|
authors:
|
13
13
|
- appboard.me
|
@@ -15,7 +15,7 @@ autorequire:
|
|
15
15
|
bindir: bin
|
16
16
|
cert_chain: []
|
17
17
|
|
18
|
-
date: 2011-06-
|
18
|
+
date: 2011-06-29 00:00:00 -04:00
|
19
19
|
default_executable:
|
20
20
|
dependencies:
|
21
21
|
- !ruby/object:Gem::Dependency
|
@@ -87,7 +87,7 @@ extensions: []
|
|
87
87
|
|
88
88
|
extra_rdoc_files:
|
89
89
|
- LICENSE.txt
|
90
|
-
- README
|
90
|
+
- README.md
|
91
91
|
files:
|
92
92
|
- lib/appboard.rb
|
93
93
|
- lib/appboard/bootstrap.rb
|
@@ -95,7 +95,7 @@ files:
|
|
95
95
|
- lib/appboard/version.rb
|
96
96
|
- lib/appboard/widget.rb
|
97
97
|
- LICENSE.txt
|
98
|
-
- README
|
98
|
+
- README.md
|
99
99
|
has_rdoc: true
|
100
100
|
homepage: https://github.com/appboard/appboard
|
101
101
|
licenses: []
|
data/README
DELETED
File without changes
|