json-rpc-objects 0.3.1 → 0.3.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/CHANGES.txt CHANGED
@@ -1,4 +1,7 @@
1
1
 
2
+ 0.3.2 (2011-02-04)
3
+ * instance attributes documentation
4
+
2
5
  0.3.1 (2011-02-03)
3
6
  * 2.0 Request and Response can receive ID as Symbol
4
7
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.3.1
1
+ 0.3.2
@@ -5,11 +5,11 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = %q{json-rpc-objects}
8
- s.version = "0.3.1"
8
+ s.version = "0.3.2"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["Martin Kozák"]
12
- s.date = %q{2011-02-03}
12
+ s.date = %q{2011-02-04}
13
13
  s.email = %q{martinkozak@martinkozak.net}
14
14
  s.extra_rdoc_files = [
15
15
  "LICENSE.txt",
@@ -22,10 +22,11 @@ module JsonRpcObjects
22
22
 
23
23
  ##
24
24
  # Holds request method name.
25
+ # @return [Object]
25
26
  #
26
-
27
- @data
27
+
28
28
  attr_accessor :data
29
+ @data
29
30
 
30
31
  ##
31
32
  # Holds link to its version module.
@@ -28,24 +28,27 @@ module JsonRpcObjects
28
28
 
29
29
  ##
30
30
  # Holds request method name.
31
+ # @return [Symbol]
31
32
  #
32
33
 
33
- @method
34
34
  attr_accessor :method
35
+ @method
35
36
 
36
37
  ##
37
38
  # Holds params for requested method.
39
+ # @return [Array]
38
40
  #
39
41
 
40
- @params
41
42
  attr_accessor :params
43
+ @params
42
44
 
43
45
  ##
44
- # Call ID.
46
+ # Call (client) ID.
47
+ # @return [Object]
45
48
  #
46
49
 
47
- @id
48
50
  attr_accessor :id
51
+ @id
49
52
 
50
53
  ##
51
54
  # Creates new one.
@@ -35,24 +35,27 @@ module JsonRpcObjects
35
35
 
36
36
  ##
37
37
  # Holds result data.
38
+ # @return [Object]
38
39
  #
39
40
 
40
- @result
41
41
  attr_accessor :result
42
+ @result
42
43
 
43
44
  ##
44
45
  # Holds error data.
46
+ # @return [JsonRpcObjects::V10::Error]
45
47
  #
46
48
 
47
- @error
48
49
  attr_accessor :error
50
+ @error
49
51
 
50
52
  ##
51
53
  # Call ID.
54
+ # @return [String]
52
55
  #
53
56
 
54
- @id
55
57
  attr_accessor :id
58
+ @id
56
59
 
57
60
  ##
58
61
  # Creates new one.
@@ -45,24 +45,27 @@ module JsonRpcObjects
45
45
 
46
46
  ##
47
47
  # Holds error code.
48
+ # @return [Integer]
48
49
  #
49
50
 
50
- @code
51
51
  attr_accessor :code
52
+ @code
52
53
 
53
54
  ##
54
55
  # Holds error message.
56
+ # @return [String]
55
57
  #
56
58
 
57
- @message
58
59
  attr_accessor :message
60
+ @message
59
61
 
60
62
  ##
61
63
  # Holds error data.
64
+ # @return [Object]
62
65
  #
63
66
 
64
- @data
65
67
  attr_accessor :data
68
+ @data
66
69
 
67
70
  ##
68
71
  # Creates new one.
@@ -27,10 +27,11 @@ module JsonRpcObjects
27
27
 
28
28
  ##
29
29
  # Holds extensions.
30
+ # @return [Hash]
30
31
  #
31
32
 
32
- @extensions
33
33
  attr_accessor :extensions
34
+ @extensions
34
35
 
35
36
  ##
36
37
  # Handles method missing call for extensions.
@@ -50,10 +50,11 @@ module JsonRpcObjects
50
50
 
51
51
  ##
52
52
  # Holds keyword parameters.
53
+ # @return [Hash]
53
54
  #
54
55
 
55
- @keyword_parameters
56
56
  attr_accessor :keyword_parameters
57
+ @keyword_parameters
57
58
 
58
59
  ##
59
60
  # Checks correctness of the request data.
@@ -64,17 +64,19 @@ module JsonRpcObjects
64
64
 
65
65
  ##
66
66
  # Holds parameter name.
67
+ # @return [Symbol]
67
68
  #
68
69
 
69
- @name
70
70
  attr_accessor :name
71
+ @name
71
72
 
72
73
  ##
73
74
  # Holds parameter type.
75
+ # @return [Class]
74
76
  #
75
77
 
76
- @type
77
78
  attr_accessor :type
79
+ @type
78
80
 
79
81
  ##
80
82
  # Creates new one.
@@ -49,52 +49,59 @@ module JsonRpcObjects
49
49
 
50
50
  ##
51
51
  # Holds service name.
52
+ # @return [Symbol]
52
53
  #
53
54
 
54
- @name
55
55
  attr_accessor :name
56
+ @name
56
57
 
57
58
  ##
58
59
  # Holds service identifier.
60
+ # @return [Addressable::URI]
59
61
  #
60
62
 
61
- @id
62
63
  attr_accessor :id
64
+ @id
63
65
 
64
66
  ##
65
67
  # Holds service version.
68
+ # @return [String]
66
69
  #
67
70
 
68
- @version
69
71
  attr_accessor :version
72
+ @version
70
73
 
71
74
  ##
72
75
  # Holds service summary.
76
+ # @return [String]
73
77
  #
74
78
 
75
- @summary
76
79
  attr_accessor :summary
80
+ @summary
77
81
 
78
82
  ##
79
83
  # Holds service help URL.
84
+ # @return [Addressable::URI]
80
85
  #
81
86
 
82
- @help
83
87
  attr_accessor :url
88
+ @help
84
89
 
85
90
  ##
86
91
  # Holds service address.
92
+ # @return [Addressable::URI]
87
93
  #
88
94
 
89
- @address
90
95
  attr_accessor :address
96
+ @address
91
97
 
92
98
  ##
93
99
  # Holds procedure descriptions.
100
+ # @return [Array]
94
101
  #
95
102
 
96
- @procs
97
103
  attr_accessor :procs
104
+ @procs
98
105
 
99
106
  ##
100
107
  # Creates new one.
@@ -45,45 +45,51 @@ module JsonRpcObjects
45
45
 
46
46
  ##
47
47
  # Holds procedure name.
48
+ # @return [Symbol]
48
49
  #
49
50
 
50
- @name
51
51
  attr_accessor :name
52
+ @name
52
53
 
53
54
  ##
54
55
  # Holds procedure summary.
56
+ # @return [String]
55
57
  #
56
58
 
57
- @summary
58
59
  attr_accessor :summary
60
+ @summary
59
61
 
60
62
  ##
61
63
  # Holds procedure help URL.
64
+ # @return [Addressable::URI]
62
65
  #
63
66
 
64
- @help
65
67
  attr_accessor :url
68
+ @help
66
69
 
67
70
  ##
68
71
  # Indicates procedure idempotency.
72
+ # @return [Boolean]
69
73
  #
70
74
 
71
- @idempotent
72
75
  attr_accessor :idempotent
76
+ @idempotent
73
77
 
74
78
  ##
75
79
  # Holds procedure params specification.
80
+ # @return [Array]
76
81
  #
77
82
 
78
- @params
79
83
  attr_accessor :params
84
+ @params
80
85
 
81
86
  ##
82
87
  # Holds procedure return value specification.
88
+ # @return [Class]
83
89
  #
84
90
 
85
- @return
86
91
  attr_accessor :return
92
+ @return
87
93
 
88
94
  ##
89
95
  # Creates new one.
metadata CHANGED
@@ -2,7 +2,7 @@
2
2
  name: json-rpc-objects
3
3
  version: !ruby/object:Gem::Version
4
4
  prerelease:
5
- version: 0.3.1
5
+ version: 0.3.2
6
6
  platform: ruby
7
7
  authors:
8
8
  - "Martin Koz\xC3\xA1k"
@@ -10,7 +10,7 @@ autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
12
 
13
- date: 2011-02-03 00:00:00 +01:00
13
+ date: 2011-02-04 00:00:00 +01:00
14
14
  default_executable:
15
15
  dependencies:
16
16
  - !ruby/object:Gem::Dependency
@@ -164,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
164
164
  requirements:
165
165
  - - ">="
166
166
  - !ruby/object:Gem::Version
167
- hash: -3248944426371010650
167
+ hash: 4421468574076853557
168
168
  segments:
169
169
  - 0
170
170
  version: "0"