cisco_spark 0.2.3 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +37 -4
- data/lib/cisco_spark.rb +2 -0
- data/lib/cisco_spark/collection.rb +1 -3
- data/lib/cisco_spark/models/team.rb +28 -0
- data/lib/cisco_spark/models/team_membership.rb +26 -0
- data/lib/cisco_spark/version.rb +1 -1
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ffd08eb8a36e9384bbc797baba2c17066106f319
|
4
|
+
data.tar.gz: 3ec3cccff026fa48c960f2f6c08de7046e9861af
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4a56357e38bcb885f81c4ff8159252d808e8e7c0f47712ed3fe93768f1a09fca15895f6d2e044d544b70d30f48b511c1cf5e564a27ee1a7d7117b18e935991f2
|
7
|
+
data.tar.gz: 916147ccf0290ac3376dc6c2bde0e855d11b7e7d84a428d57de2c07d5472e9d888885d51c823fa749f9815e2729ffcfe25dd581eede3bb984b2c58200a0e4c20
|
data/README.md
CHANGED
@@ -23,7 +23,7 @@ Or install it yourself as:
|
|
23
23
|
## Usage
|
24
24
|
|
25
25
|
### Configuration
|
26
|
-
Configuration can be done in an initializer on app boot.
|
26
|
+
Configuration can be done in an initializer on app boot.
|
27
27
|
An API key or users OAuth token is required to make any API requests.
|
28
28
|
|
29
29
|
API key example:
|
@@ -50,6 +50,8 @@ Inlcuded models:
|
|
50
50
|
- `CiscoSpark::Room`
|
51
51
|
- `CiscoSpark::Membership`
|
52
52
|
- `CiscoSpark::Message`
|
53
|
+
- `CiscoSpark::Team`
|
54
|
+
- `CiscoSpark::TeamMembership`
|
53
55
|
- `CiscoSpark::Webhook`
|
54
56
|
|
55
57
|
You can call all the following methods on any of these models
|
@@ -168,7 +170,7 @@ room.to_h
|
|
168
170
|
[API reference](https://developer.ciscospark.com/resource-people.html)
|
169
171
|
|
170
172
|
###### `CiscoSpark::Person.all_by_email`
|
171
|
-
Search all people by email,
|
173
|
+
Search all people by email,
|
172
174
|
|
173
175
|
```ruby
|
174
176
|
people = CiscoSpark::Person.all_by_email('nickpmaher@gmail.com', max: 5)
|
@@ -241,7 +243,7 @@ room.send_message(message)
|
|
241
243
|
```
|
242
244
|
|
243
245
|
###### `#add_person`
|
244
|
-
Creates a new membership to the room for a given person
|
246
|
+
Creates a new membership to the room for a given person
|
245
247
|
|
246
248
|
```ruby
|
247
249
|
person = CiscoSpark::Person.fetch('Y2lz')
|
@@ -269,6 +271,38 @@ Returns the person that sent this message
|
|
269
271
|
###### `#person_to`
|
270
272
|
Returns the person that the message was sent to
|
271
273
|
|
274
|
+
##### `CiscoSpark::Team`
|
275
|
+
[API reference](https://developer.ciscospark.com/resource-teams.html)
|
276
|
+
|
277
|
+
###### `#memberships`
|
278
|
+
Get all memberships for team
|
279
|
+
|
280
|
+
```ruby
|
281
|
+
team = CiscoSpark::Team.new(id: 'Y3de...')
|
282
|
+
team.memberships(max: 5)
|
283
|
+
=> #<CiscoSpark::Collection>
|
284
|
+
```
|
285
|
+
|
286
|
+
###### `#add_person`
|
287
|
+
Creates a new membership to the team for a given person
|
288
|
+
|
289
|
+
```ruby
|
290
|
+
person = CiscoSpark::Person.fetch('Y2lz')
|
291
|
+
|
292
|
+
team = CiscoSpark::Team.new(id: 'Y3de...')
|
293
|
+
team.add_person(person)
|
294
|
+
=> #<CiscoSpark::TeamMembership>
|
295
|
+
```
|
296
|
+
|
297
|
+
##### `CiscoSpark::TeamMembership`
|
298
|
+
[API reference](https://developer.ciscospark.com/resource-team-memberships.html)
|
299
|
+
|
300
|
+
###### `#person`
|
301
|
+
Returns the person for this membership
|
302
|
+
|
303
|
+
###### `#team`
|
304
|
+
Returns the team this membership belongs to
|
305
|
+
|
272
306
|
##### `CiscoSpark::Webhook`
|
273
307
|
[API reference](https://developer.ciscospark.com/resource-webhooks.html)
|
274
308
|
|
@@ -290,4 +324,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/NGMarm
|
|
290
324
|
## License
|
291
325
|
|
292
326
|
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
293
|
-
|
data/lib/cisco_spark.rb
CHANGED
@@ -7,6 +7,8 @@ require "cisco_spark/models/membership"
|
|
7
7
|
require "cisco_spark/models/message"
|
8
8
|
require "cisco_spark/models/person"
|
9
9
|
require "cisco_spark/models/room"
|
10
|
+
require "cisco_spark/models/team"
|
11
|
+
require "cisco_spark/models/team_membership"
|
10
12
|
require "cisco_spark/models/webhook"
|
11
13
|
|
12
14
|
|
@@ -0,0 +1,28 @@
|
|
1
|
+
require "cisco_spark/model"
|
2
|
+
|
3
|
+
module CiscoSpark
|
4
|
+
class Team
|
5
|
+
include Model
|
6
|
+
resource 'teams'
|
7
|
+
|
8
|
+
attributes(
|
9
|
+
id: DataCaster::String,
|
10
|
+
name: DataCaster::String,
|
11
|
+
created: DataCaster::DateTime
|
12
|
+
)
|
13
|
+
mutable_attributes :name
|
14
|
+
|
15
|
+
def memberships(options={})
|
16
|
+
options[:team_id] = id
|
17
|
+
CiscoSpark::TeamMembership.fetch_all(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
def add_person(person, options={})
|
21
|
+
CiscoSpark::TeamMembership.new(
|
22
|
+
team_id: id,
|
23
|
+
person_id: person.id,
|
24
|
+
is_moderator: options.fetch(:is_moderator, false),
|
25
|
+
).persist
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
require "cisco_spark/model"
|
2
|
+
|
3
|
+
module CiscoSpark
|
4
|
+
class TeamMembership
|
5
|
+
include Model
|
6
|
+
resource 'team/memberships'
|
7
|
+
|
8
|
+
attributes(
|
9
|
+
id: DataCaster::String,
|
10
|
+
team_id: DataCaster::String,
|
11
|
+
person_id: DataCaster::String,
|
12
|
+
person_email: DataCaster::String,
|
13
|
+
is_moderator: DataCaster::Boolean,
|
14
|
+
created: DataCaster::DateTime,
|
15
|
+
)
|
16
|
+
mutable_attributes :is_moderator
|
17
|
+
|
18
|
+
def person
|
19
|
+
CiscoSpark::Person.fetch(person_id)
|
20
|
+
end
|
21
|
+
|
22
|
+
def team
|
23
|
+
CiscoSpark::Team.fetch(team_id)
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
data/lib/cisco_spark/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: cisco_spark
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Nick Maher
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2016-
|
11
|
+
date: 2016-11-12 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -111,6 +111,8 @@ files:
|
|
111
111
|
- lib/cisco_spark/models/message.rb
|
112
112
|
- lib/cisco_spark/models/person.rb
|
113
113
|
- lib/cisco_spark/models/room.rb
|
114
|
+
- lib/cisco_spark/models/team.rb
|
115
|
+
- lib/cisco_spark/models/team_membership.rb
|
114
116
|
- lib/cisco_spark/models/webhook.rb
|
115
117
|
- lib/cisco_spark/utils.rb
|
116
118
|
- lib/cisco_spark/version.rb
|