clarify 0.9.9 → 1.0.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.
- checksums.yaml +8 -8
- data/README.md +3 -3
- data/lib/clarify/bundle.rb +5 -9
- data/lib/clarify/configuration.rb +9 -1
- data/lib/clarify/metadata.rb +3 -7
- data/lib/clarify/request.rb +6 -5
- data/lib/clarify/search.rb +1 -5
- data/lib/clarify/track.rb +5 -9
- data/lib/clarify/version.rb +1 -1
- data/spec/lib/clarify/configuration_spec.rb +5 -0
- data/spec/spec_helper.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,15 +1,15 @@
|
|
1
1
|
---
|
2
2
|
!binary "U0hBMQ==":
|
3
3
|
metadata.gz: !binary |-
|
4
|
-
|
4
|
+
MzBkMDZjYzI0OTBlMmQxYmI2NzRiY2E0NTNmNjVmNmFmMDc1MWI0YQ==
|
5
5
|
data.tar.gz: !binary |-
|
6
|
-
|
6
|
+
NGI4MWVhMGQ4NmE2OGNmYmZhNGVjNjJmYzI4NTIzMWMxYjM0OTk5NA==
|
7
7
|
SHA512:
|
8
8
|
metadata.gz: !binary |-
|
9
|
-
|
10
|
-
|
11
|
-
|
9
|
+
YjA3N2ZiZjc2ZGE0NDMxNTY0ZjJlZDFiMjU2NzJlNmU4ZmI4NDllMWE2ZjFm
|
10
|
+
Yjk0NGE2MzY3NmY4OGMyOTc4MWE1NWEwNTZiNTk3NWE0NjNlOGQwNzc0Mjlj
|
11
|
+
NzA0MDUxODBkNzJmMWY4MWIzMTMwZDRhNTJmMTM0N2M2Yzg4ZmY=
|
12
12
|
data.tar.gz: !binary |-
|
13
|
-
|
14
|
-
|
15
|
-
|
13
|
+
NWFmNDI2MmI5MjQwNzY0ZTY0NzA2YTYwMmFhODllZTI1MjIwNzRiN2IwMDc4
|
14
|
+
M2M3MDM4NDQxMTQ1YTg1MWNkNmNlMGU0MDU0YWU5M2NhMmM4NGJhN2QzMzI1
|
15
|
+
ZWZlZjU4MDI1OGQyZjAxMDVjNGFhNmEzNmRmYmRkMTZlMGUwN2Q=
|
data/README.md
CHANGED
@@ -6,7 +6,7 @@ A gem to communicate with the ClarifyAPI.
|
|
6
6
|
|
7
7
|
Add this line to your application's Gemfile:
|
8
8
|
|
9
|
-
gem 'clarify'
|
9
|
+
gem 'clarify'
|
10
10
|
|
11
11
|
And then execute:
|
12
12
|
|
@@ -23,6 +23,7 @@ Clarify.configure do |config|
|
|
23
23
|
config.api_key = 'CLARIFY_API_KEY'
|
24
24
|
# if key in ENV
|
25
25
|
# config.api_key = ENV['CLARIFY_API_KEY']
|
26
|
+
config.version = 1 #default is latest api version
|
26
27
|
end
|
27
28
|
```
|
28
29
|
|
@@ -52,8 +53,7 @@ By default, it uses the newest version of the API. If you want to use a specific
|
|
52
53
|
|
53
54
|
## Usage
|
54
55
|
|
55
|
-
Clarify::Bundle.new.find_all
|
56
|
-
Clarify::Bundle.new(4).find_all # uses version 4
|
56
|
+
Clarify::Bundle.new.find_all
|
57
57
|
|
58
58
|
## Contributing
|
59
59
|
|
data/lib/clarify/bundle.rb
CHANGED
@@ -2,13 +2,9 @@ require_relative 'request'
|
|
2
2
|
|
3
3
|
module Clarify
|
4
4
|
class Bundle < Request
|
5
|
-
|
6
|
-
def initialize(version = 1)
|
7
|
-
super(version)
|
8
|
-
end
|
9
5
|
|
10
6
|
def create(query={})
|
11
|
-
response = self.class.post("/#{
|
7
|
+
response = self.class.post("/#{version_name}/bundles",
|
12
8
|
query: query,
|
13
9
|
headers: self.headers)
|
14
10
|
build_response(response)
|
@@ -16,22 +12,22 @@ module Clarify
|
|
16
12
|
|
17
13
|
def find(bundle_id, args={})
|
18
14
|
raise ArgumentError, "Missing bundle id" if bundle_id.nil?
|
19
|
-
response = self.class.get("/#{
|
15
|
+
response = self.class.get("/#{version_name}/bundles/#{bundle_id}", query: args, headers: headers)
|
20
16
|
build_response(response)
|
21
17
|
end
|
22
18
|
|
23
19
|
def find_all(args={})
|
24
|
-
response = self.class.get("/#{
|
20
|
+
response = self.class.get("/#{version_name}/bundles", headers: headers)
|
25
21
|
build_response(response)
|
26
22
|
end
|
27
23
|
|
28
24
|
def delete(bundle_id)
|
29
|
-
response = self.class.delete("/#{
|
25
|
+
response = self.class.delete("/#{version_name}/bundles/#{bundle_id}", headers: headers)
|
30
26
|
build_response(response)
|
31
27
|
end
|
32
28
|
|
33
29
|
def update(bundle_id, query={})
|
34
|
-
response = self.class.put("/#{
|
30
|
+
response = self.class.put("/#{version_name}/bundles/#{bundle_id}",
|
35
31
|
body: query, headers: headers)
|
36
32
|
build_response(response)
|
37
33
|
end
|
@@ -1,8 +1,16 @@
|
|
1
1
|
module Clarify
|
2
2
|
class Configuration
|
3
|
-
|
3
|
+
|
4
|
+
attr_accessor :api_key, :version_name, :version
|
5
|
+
|
4
6
|
def initialize
|
5
7
|
@api_key = 'api key here'
|
8
|
+
@version = '1' # latest version is default
|
6
9
|
end
|
10
|
+
|
11
|
+
def version_name
|
12
|
+
"v#{@version}"
|
13
|
+
end
|
14
|
+
|
7
15
|
end
|
8
16
|
end
|
data/lib/clarify/metadata.rb
CHANGED
@@ -2,26 +2,22 @@ require_relative 'request'
|
|
2
2
|
|
3
3
|
module Clarify
|
4
4
|
class Metadata < Request
|
5
|
-
|
6
|
-
def initialize(version=1)
|
7
|
-
super(version)
|
8
|
-
end
|
9
5
|
|
10
6
|
def find(bundle_id)
|
11
7
|
raise ArgumentError, "Missing bundle id" if bundle_id.nil?
|
12
|
-
response = self.class.get("/#{
|
8
|
+
response = self.class.get("/#{version_name}/bundles/#{bundle_id}/metadata", headers: headers)
|
13
9
|
build_response(response)
|
14
10
|
end
|
15
11
|
|
16
12
|
def delete(bundle_id)
|
17
13
|
raise ArgumentError, "Missing bundle id" if bundle_id.nil?
|
18
|
-
response = self.class.delete("/#{
|
14
|
+
response = self.class.delete("/#{version_name}/bundles/#{bundle_id}/metadata", headers: headers)
|
19
15
|
build_response(response)
|
20
16
|
end
|
21
17
|
|
22
18
|
def update(bundle_id, data="")
|
23
19
|
raise ArgumentError, "Missing bundle id" if bundle_id.nil?
|
24
|
-
response = self.class.put("/#{
|
20
|
+
response = self.class.put("/#{version_name}/bundles/#{bundle_id}/metadata",
|
25
21
|
body: {data: data} , headers: headers)
|
26
22
|
build_response(response)
|
27
23
|
end
|
data/lib/clarify/request.rb
CHANGED
@@ -12,15 +12,16 @@ module Clarify
|
|
12
12
|
#uncomment below for httparty debugging
|
13
13
|
#debug_output
|
14
14
|
|
15
|
-
attr_accessor :
|
15
|
+
attr_accessor :version_name, :api_key
|
16
16
|
|
17
|
-
def initialize
|
18
|
-
@
|
19
|
-
@api_key = Clarify.configuration.api_key
|
17
|
+
def initialize
|
18
|
+
@version_name = Clarify.configuration.version_name
|
19
|
+
@api_key = Clarify.configuration.api_key
|
20
20
|
end
|
21
21
|
|
22
22
|
def headers
|
23
|
-
{"Authorization" => "Bearer #{@api_key}"
|
23
|
+
{"Authorization" => "Bearer #{@api_key}",
|
24
|
+
"User-Agent" => "clarify-gem/#{Clarify::VERSION}/#{Gem.ruby_version.version}"}
|
24
25
|
end
|
25
26
|
|
26
27
|
def build_response(response)
|
data/lib/clarify/search.rb
CHANGED
@@ -1,12 +1,8 @@
|
|
1
1
|
module Clarify
|
2
2
|
class Search < Request
|
3
|
-
|
4
|
-
def initialize(version="1")
|
5
|
-
super(version)
|
6
|
-
end
|
7
3
|
|
8
4
|
def perform(query={})
|
9
|
-
response = self.class.get("/#{
|
5
|
+
response = self.class.get("/#{version_name}/search", query: query, headers: headers)
|
10
6
|
build_response(response)
|
11
7
|
end
|
12
8
|
|
data/lib/clarify/track.rb
CHANGED
@@ -3,40 +3,36 @@ require_relative 'request'
|
|
3
3
|
module Clarify
|
4
4
|
class Track < Request
|
5
5
|
|
6
|
-
def initialize(version=1)
|
7
|
-
super(version)
|
8
|
-
end
|
9
|
-
|
10
6
|
def all(bundle_id)
|
11
7
|
raise ArgumentError, "Missing bundle id" if bundle_id.nil?
|
12
|
-
response = self.class.get("/#{
|
8
|
+
response = self.class.get("/#{version_name}/bundles/#{bundle_id}/tracks", headers: headers)
|
13
9
|
build_response(response)
|
14
10
|
end
|
15
11
|
|
16
12
|
def add(bundle_id, media_url)
|
17
13
|
raise ArgumentError, "Missing bundle id" if bundle_id.nil?
|
18
14
|
raise ArgumentError, "Missing media_url" if media_url.nil?
|
19
|
-
response = self.class.post("/#{
|
15
|
+
response = self.class.post("/#{version_name}/bundles/#{bundle_id}/tracks", body: {media_url: media_url}, headers: headers)
|
20
16
|
build_response(response)
|
21
17
|
end
|
22
18
|
|
23
19
|
def delete(bundle_id, track="")
|
24
20
|
raise ArgumentError, "Missing bundle id" if bundle_id.nil?
|
25
|
-
response = self.class.delete("/#{
|
21
|
+
response = self.class.delete("/#{version_name}/bundles/#{bundle_id}/tracks", query: {track: track}, headers: headers)
|
26
22
|
build_response(response)
|
27
23
|
end
|
28
24
|
|
29
25
|
def delete_by_id(bundle_id, track_id)
|
30
26
|
raise ArgumentError, "Missing bundle id" if bundle_id.nil?
|
31
27
|
raise ArgumentError, "Missing track id" if track_id.nil?
|
32
|
-
response = self.class.delete("/#{
|
28
|
+
response = self.class.delete("/#{version_name}/bundles/#{bundle_id}/tracks/#{track_id}", headers: headers)
|
33
29
|
build_response(response)
|
34
30
|
end
|
35
31
|
|
36
32
|
def find(bundle_id, track_id)
|
37
33
|
raise ArgumentError, "Missing bundle id" if bundle_id.nil?
|
38
34
|
raise ArgumentError, "Missing track id" if track_id.nil?
|
39
|
-
response = self.class.get("/#{
|
35
|
+
response = self.class.get("/#{version_name}/bundles/#{bundle_id}/tracks/#{track_id}", headers: headers)
|
40
36
|
build_response(response)
|
41
37
|
end
|
42
38
|
|
data/lib/clarify/version.rb
CHANGED
@@ -3,12 +3,17 @@ module Clarify
|
|
3
3
|
before do
|
4
4
|
Clarify.configure do |config|
|
5
5
|
config.api_key = ENV['CLARIFY_API_KEY']
|
6
|
+
config.version = 5
|
6
7
|
end
|
7
8
|
end
|
8
9
|
|
9
10
|
it "should set the api_key in configuration" do
|
10
11
|
expect(Request.new.api_key).to eql(ENV['CLARIFY_API_KEY'])
|
11
12
|
end
|
13
|
+
|
14
|
+
it "should set the version number in the configuration" do
|
15
|
+
expect(Request.new.version_name).to eql("v5")
|
16
|
+
end
|
12
17
|
end
|
13
18
|
end
|
14
19
|
|
data/spec/spec_helper.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: clarify
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 1.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- rubygeek
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2014-09-
|
11
|
+
date: 2014-09-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: httparty
|