README.md in cistern-2.0.5 vs README.md in cistern-2.1.0
- old
+ new
@@ -14,11 +14,13 @@
This represents the remote service that you are wrapping. If the service name is `foo` then a good name is `Foo::Client`.
Service initialization parameters are enumerated by `requires` and `recognizes`. Parameters defined using `recognizes` are optional.
```ruby
-class Foo::Client < Cistern::Service
+class Foo::Client
+ include Cistern::Client
+
requires :hmac_id, :hmac_secret
recognizes :url
end
# Acceptable
@@ -83,11 +85,11 @@
Foo::Client.new.respond_to?(:get_bars) # false
Foo::Client.new.get_all_the_bars # "all the bars"
```
-All declared requests can be listed via `Cistern::Service#requests`.
+All declared requests can be listed via `Cistern::Client#requests`.
```ruby
Foo::Client.requests # => [Foo::Client::GetBars, Foo::Client::GetBar]
```
@@ -231,10 +233,12 @@
* `fetch` and `[]` read
You can make the service bypass Cistern's mock data structures by simply creating a `self.data` function in your service `Mock` declaration.
```ruby
-class Foo::Client < Cistern::Service
+class Foo::Client
+ include Cistern::Client
+
class Mock
def self.data
@data ||= {}
end
end