easy-api 0.1.0 → 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +1 -1
- data/lib/easy/api/error.rb +8 -8
- data/lib/easy/api/result.rb +1 -1
- data/lib/easy/api/version.rb +1 -1
- metadata +82 -75
data/README.md
CHANGED
@@ -42,7 +42,7 @@ Add the following line to all Api Controllers:
|
|
42
42
|
then in your Api actions, add values to the @result (Easy::Api::Result) object.
|
43
43
|
If the request is a success, you must set
|
44
44
|
|
45
|
-
@result.status_code =
|
45
|
+
@result.status_code = 200
|
46
46
|
@result.success = true
|
47
47
|
|
48
48
|
and you can also set any other values you want to send back, e.g.
|
data/lib/easy/api/error.rb
CHANGED
@@ -5,19 +5,19 @@ module Easy::Api
|
|
5
5
|
|
6
6
|
def self.codes
|
7
7
|
{
|
8
|
-
invalid
|
9
|
-
unauthorized
|
10
|
-
not_found
|
11
|
-
unexpected
|
8
|
+
:invalid => 400,
|
9
|
+
:unauthorized => 401,
|
10
|
+
:not_found => 404,
|
11
|
+
:unexpected => 500
|
12
12
|
}
|
13
13
|
end
|
14
14
|
|
15
15
|
def self.messages
|
16
16
|
{
|
17
|
-
invalid
|
18
|
-
unauthorized
|
19
|
-
not_found
|
20
|
-
unexpected
|
17
|
+
:invalid => "Invalid request",
|
18
|
+
:unauthorized => "This request requires a valid Private API Key",
|
19
|
+
:not_found => "Resource not found",
|
20
|
+
:unexpected => 'Sorry! An exception has occured. Please try again later',
|
21
21
|
}
|
22
22
|
end
|
23
23
|
|
data/lib/easy/api/result.rb
CHANGED
data/lib/easy/api/version.rb
CHANGED
metadata
CHANGED
@@ -1,87 +1,91 @@
|
|
1
|
-
--- !ruby/object:Gem::Specification
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
2
|
name: easy-api
|
3
|
-
version: !ruby/object:Gem::Version
|
4
|
-
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
hash: 25
|
5
5
|
prerelease:
|
6
|
+
segments:
|
7
|
+
- 0
|
8
|
+
- 1
|
9
|
+
- 1
|
10
|
+
version: 0.1.1
|
6
11
|
platform: ruby
|
7
|
-
authors:
|
12
|
+
authors:
|
8
13
|
- Shevaun Coker
|
9
14
|
autorequire:
|
10
15
|
bindir: bin
|
11
16
|
cert_chain: []
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
+
|
18
|
+
date: 2013-03-11 00:00:00 Z
|
19
|
+
dependencies:
|
20
|
+
- !ruby/object:Gem::Dependency
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: &id001 !ruby/object:Gem::Requirement
|
17
23
|
none: false
|
18
|
-
requirements:
|
19
|
-
- -
|
20
|
-
- !ruby/object:Gem::Version
|
24
|
+
requirements:
|
25
|
+
- - ">="
|
26
|
+
- !ruby/object:Gem::Version
|
27
|
+
hash: 7
|
28
|
+
segments:
|
29
|
+
- 3
|
30
|
+
- 0
|
31
|
+
- 0
|
21
32
|
version: 3.0.0
|
33
|
+
requirement: *id001
|
34
|
+
name: rails
|
22
35
|
type: :runtime
|
36
|
+
- !ruby/object:Gem::Dependency
|
23
37
|
prerelease: false
|
24
|
-
version_requirements: !ruby/object:Gem::Requirement
|
38
|
+
version_requirements: &id002 !ruby/object:Gem::Requirement
|
25
39
|
none: false
|
26
|
-
requirements:
|
27
|
-
- -
|
28
|
-
- !ruby/object:Gem::Version
|
29
|
-
|
30
|
-
|
40
|
+
requirements:
|
41
|
+
- - ">="
|
42
|
+
- !ruby/object:Gem::Version
|
43
|
+
hash: 3
|
44
|
+
segments:
|
45
|
+
- 0
|
46
|
+
version: "0"
|
47
|
+
requirement: *id002
|
31
48
|
name: bundler
|
32
|
-
requirement: !ruby/object:Gem::Requirement
|
33
|
-
none: false
|
34
|
-
requirements:
|
35
|
-
- - ! '>='
|
36
|
-
- !ruby/object:Gem::Version
|
37
|
-
version: '0'
|
38
49
|
type: :development
|
50
|
+
- !ruby/object:Gem::Dependency
|
39
51
|
prerelease: false
|
40
|
-
version_requirements: !ruby/object:Gem::Requirement
|
52
|
+
version_requirements: &id003 !ruby/object:Gem::Requirement
|
41
53
|
none: false
|
42
|
-
requirements:
|
43
|
-
- -
|
44
|
-
- !ruby/object:Gem::Version
|
45
|
-
|
46
|
-
|
54
|
+
requirements:
|
55
|
+
- - ">="
|
56
|
+
- !ruby/object:Gem::Version
|
57
|
+
hash: 3
|
58
|
+
segments:
|
59
|
+
- 0
|
60
|
+
version: "0"
|
61
|
+
requirement: *id003
|
47
62
|
name: pry
|
48
|
-
requirement: !ruby/object:Gem::Requirement
|
49
|
-
none: false
|
50
|
-
requirements:
|
51
|
-
- - ! '>='
|
52
|
-
- !ruby/object:Gem::Version
|
53
|
-
version: '0'
|
54
63
|
type: :development
|
64
|
+
- !ruby/object:Gem::Dependency
|
55
65
|
prerelease: false
|
56
|
-
version_requirements: !ruby/object:Gem::Requirement
|
66
|
+
version_requirements: &id004 !ruby/object:Gem::Requirement
|
57
67
|
none: false
|
58
|
-
requirements:
|
59
|
-
- - ! '>='
|
60
|
-
- !ruby/object:Gem::Version
|
61
|
-
version: '0'
|
62
|
-
- !ruby/object:Gem::Dependency
|
63
|
-
name: rspec
|
64
|
-
requirement: !ruby/object:Gem::Requirement
|
65
|
-
none: false
|
66
|
-
requirements:
|
68
|
+
requirements:
|
67
69
|
- - ~>
|
68
|
-
- !ruby/object:Gem::Version
|
69
|
-
|
70
|
+
- !ruby/object:Gem::Version
|
71
|
+
hash: 3
|
72
|
+
segments:
|
73
|
+
- 2
|
74
|
+
- 0
|
75
|
+
version: "2.0"
|
76
|
+
requirement: *id004
|
77
|
+
name: rspec
|
70
78
|
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: '2.0'
|
78
79
|
description: A repository of common, reusable API code
|
79
|
-
email:
|
80
|
+
email:
|
80
81
|
- shevaun.coker@abletech.co.nz
|
81
82
|
executables: []
|
83
|
+
|
82
84
|
extensions: []
|
85
|
+
|
83
86
|
extra_rdoc_files: []
|
84
|
-
|
87
|
+
|
88
|
+
files:
|
85
89
|
- .gitignore
|
86
90
|
- Gemfile
|
87
91
|
- LICENSE
|
@@ -96,37 +100,40 @@ files:
|
|
96
100
|
- spec/lib/easy/api/error_spec.rb
|
97
101
|
- spec/lib/easy/api/result_spec.rb
|
98
102
|
- spec/spec_helper.rb
|
99
|
-
homepage:
|
103
|
+
homepage: ""
|
100
104
|
licenses: []
|
105
|
+
|
101
106
|
post_install_message:
|
102
107
|
rdoc_options: []
|
103
|
-
|
108
|
+
|
109
|
+
require_paths:
|
104
110
|
- lib
|
105
|
-
required_ruby_version: !ruby/object:Gem::Requirement
|
111
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
106
112
|
none: false
|
107
|
-
requirements:
|
108
|
-
- -
|
109
|
-
- !ruby/object:Gem::Version
|
110
|
-
|
111
|
-
segments:
|
113
|
+
requirements:
|
114
|
+
- - ">="
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
hash: 3
|
117
|
+
segments:
|
112
118
|
- 0
|
113
|
-
|
114
|
-
required_rubygems_version: !ruby/object:Gem::Requirement
|
119
|
+
version: "0"
|
120
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
115
121
|
none: false
|
116
|
-
requirements:
|
117
|
-
- -
|
118
|
-
- !ruby/object:Gem::Version
|
119
|
-
|
120
|
-
segments:
|
122
|
+
requirements:
|
123
|
+
- - ">="
|
124
|
+
- !ruby/object:Gem::Version
|
125
|
+
hash: 3
|
126
|
+
segments:
|
121
127
|
- 0
|
122
|
-
|
128
|
+
version: "0"
|
123
129
|
requirements: []
|
130
|
+
|
124
131
|
rubyforge_project:
|
125
|
-
rubygems_version: 1.8.
|
132
|
+
rubygems_version: 1.8.16
|
126
133
|
signing_key:
|
127
134
|
specification_version: 3
|
128
135
|
summary: Provides consistent responses for Abletech APIs
|
129
|
-
test_files:
|
136
|
+
test_files:
|
130
137
|
- spec/lib/easy/api/error_spec.rb
|
131
138
|
- spec/lib/easy/api/result_spec.rb
|
132
139
|
- spec/spec_helper.rb
|