apiaryio 0.2.2 → 0.2.3
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 +6 -2
- data/apiary.gemspec +0 -1
- data/lib/apiary/common.rb +1 -15
- data/lib/apiary/version.rb +1 -1
- data/spec/common_spec.rb +0 -14
- metadata +4 -20
data/README.md
CHANGED
@@ -24,8 +24,12 @@ export APIARY_API_KEY=<your_token_retrieved_on_step_1>
|
|
24
24
|
|
25
25
|
## Description
|
26
26
|
|
27
|
-
|
28
|
-
|
27
|
+
The Apiary CLI gem is a command line tool for developing and previewing
|
28
|
+
API Blueprint documents locally. It can also be used for pushing
|
29
|
+
updated documents to and fetching existing documents from Apiary.io.
|
30
|
+
|
31
|
+
Please see the [full documentation](http://client.apiary.io) for an in-depth
|
32
|
+
look in how to use this tool.
|
29
33
|
|
30
34
|
## Usage
|
31
35
|
|
data/apiary.gemspec
CHANGED
@@ -20,7 +20,6 @@ Gem::Specification.new do |gem|
|
|
20
20
|
gem.add_dependency "rack", ">= 1.4.0", "< 1.6.0"
|
21
21
|
gem.add_dependency "rake", "~> 10.3.2"
|
22
22
|
gem.add_dependency "thor", "~> 0.19.1"
|
23
|
-
gem.add_dependency "redsnow", "~> 0.3.2"
|
24
23
|
|
25
24
|
gem.add_runtime_dependency "json", "~> 1.8.1"
|
26
25
|
|
data/lib/apiary/common.rb
CHANGED
@@ -1,5 +1,4 @@
|
|
1
1
|
# encoding: utf-8
|
2
|
-
require 'redsnow'
|
3
2
|
|
4
3
|
module Apiary
|
5
4
|
# Common function used in commands
|
@@ -10,24 +9,11 @@ module Apiary
|
|
10
9
|
def initialize()
|
11
10
|
end
|
12
11
|
|
13
|
-
def validate_blueprint(code)
|
14
|
-
result = RedSnow.parse(code)
|
15
|
-
if result.error[:code] == 0
|
16
|
-
@error_message = nil
|
17
|
-
return true
|
18
|
-
else
|
19
|
-
@error_message = result.error[:message]
|
20
|
-
puts "Blueprint validation error: #{@error_message}"
|
21
|
-
return false
|
22
|
-
end
|
23
|
-
end
|
24
|
-
|
25
12
|
def validate_apib_file(apib_file)
|
26
13
|
unless File.exist?(apib_file)
|
27
14
|
raise "Apiary definition file hasn't been found: #{apib_file.inspect}"
|
28
15
|
end
|
29
|
-
|
30
|
-
return validate_blueprint(code)
|
16
|
+
File.read(apib_file)
|
31
17
|
end
|
32
18
|
|
33
19
|
end
|
data/lib/apiary/version.rb
CHANGED
data/spec/common_spec.rb
CHANGED
@@ -16,18 +16,4 @@ describe Apiary::Common do
|
|
16
16
|
|
17
17
|
end
|
18
18
|
|
19
|
-
describe 'Validate blueprint' do
|
20
|
-
|
21
|
-
it 'test validate blueprint' do
|
22
|
-
common = Apiary::Common.new
|
23
|
-
expect(common.validate_blueprint('# API_NAME')).to be_truthy
|
24
|
-
end
|
25
|
-
|
26
|
-
it 'test invalidate blueprint' do
|
27
|
-
common = Apiary::Common.new
|
28
|
-
expect(common.validate_blueprint("\t# API_NAME\t\r\n## Group Name")).to be_falsey
|
29
|
-
end
|
30
|
-
|
31
|
-
end
|
32
|
-
|
33
19
|
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: apiaryio
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.2.
|
4
|
+
version: 0.2.3
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2014-
|
12
|
+
date: 2014-12-28 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: rest-client
|
@@ -81,22 +81,6 @@ dependencies:
|
|
81
81
|
- - ~>
|
82
82
|
- !ruby/object:Gem::Version
|
83
83
|
version: 0.19.1
|
84
|
-
- !ruby/object:Gem::Dependency
|
85
|
-
name: redsnow
|
86
|
-
requirement: !ruby/object:Gem::Requirement
|
87
|
-
none: false
|
88
|
-
requirements:
|
89
|
-
- - ~>
|
90
|
-
- !ruby/object:Gem::Version
|
91
|
-
version: 0.3.2
|
92
|
-
type: :runtime
|
93
|
-
prerelease: false
|
94
|
-
version_requirements: !ruby/object:Gem::Requirement
|
95
|
-
none: false
|
96
|
-
requirements:
|
97
|
-
- - ~>
|
98
|
-
- !ruby/object:Gem::Version
|
99
|
-
version: 0.3.2
|
100
84
|
- !ruby/object:Gem::Dependency
|
101
85
|
name: json
|
102
86
|
requirement: !ruby/object:Gem::Requirement
|
@@ -247,7 +231,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
247
231
|
version: '0'
|
248
232
|
segments:
|
249
233
|
- 0
|
250
|
-
hash:
|
234
|
+
hash: -1308694779434549547
|
251
235
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
252
236
|
none: false
|
253
237
|
requirements:
|
@@ -256,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
256
240
|
version: '0'
|
257
241
|
segments:
|
258
242
|
- 0
|
259
|
-
hash:
|
243
|
+
hash: -1308694779434549547
|
260
244
|
requirements: []
|
261
245
|
rubyforge_project:
|
262
246
|
rubygems_version: 1.8.23
|