simple_response 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00a4c66d5cb1aa579d9a927d8d721d4068131623
-  data.tar.gz: 4c44f3771dde17e78e78386e2210bf4d806820ed
+  metadata.gz: b8b127d41f2b2ef515fbdbb87348d006ad2212e6
+  data.tar.gz: 16650b8be8ab004edd6fe2ef7540efc54906a305
 SHA512:
-  metadata.gz: 5dc3e1810ad210658789b3b3b22815f6bd4ef84940093e2472d919b99844c893db0c51ccd796337b2e114f98c7ca7ead82a97e82bbc8a216a835e03e98fce5e9
-  data.tar.gz: e815e7190453944f818ef57a81c9b52974770f53cb2271968134beb93e9e38140a5fad41b2193576ebf5b20131cc27af8ec707dbd145ef3e8c32453bbc3bb3a4
+  metadata.gz: 26ffe67bb2833619847313145607b426f8075660fe90fd85882c4241e77074ec7489d8da527055787e590283afd8b35ae58278edc43eae2a3cbf342494b48ba2
+  data.tar.gz: cf84ffd0d61d245c527230f89935c13f1b09b3e02e8678ffb1eec1a86f840677c9b2b2a4b2895cdbd8f7a05289a1e73914a28d1c1057819430e4266e98758286

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_response (0.4.0)
+    simple_response (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,10 +1,46 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/54e7c14cd8f10bd26aa5/maintainability)](https://codeclimate.com/github/giovannibenussi/simple-response/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/54e7c14cd8f10bd26aa5/test_coverage)](https://codeclimate.com/github/giovannibenussi/simple-response/test_coverage)
+<a target="_blank" href="https://badge.fury.io/rb/simple_response"><img src="https://badge.fury.io/rb/simple_response.svg" alt="Gem Version" height="18"></a>
+
 # SimpleResponse
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/simple_response`. To experiment with that code, run `bin/console` for an interactive prompt.
+SimpleResponse is a lightweight gem that will allow you to create Response Objects in an easy but robust way.
+
+Basically, a Response Object is an object that improves the communication between the functions of your application. By using them, you will be able to reduce the number of bugs and its hunt easier than alternative ways like return boolean or string values.
+
+<!-- In a Response Object you have two types of responses: success and failures. Also, you could associate any data that you want with the Response Object in case you need to provide extra data. -->
+In a Response Object you can have two types of responses (success and failure) and any custom associated data that you want.
+
+Following is a simple code that uses SimpleResponse to improve both its readability and flow control.
+
+```ruby
+response = ThirdPartyAPI.get('posts')
+if response.success?
+  puts "Post retrieval succeeds in #{response.retrieval_time}"
+  puts "We retrieve #{response.posts.count} posts."
+else
+  puts "Error retrieving posts: #{response.error_message}"
+end
+```
+
+To implement this, you could write something like this using SimpleResponse gem:
+
+```ruby
+class ThirdPartyAPI
+  def get('posts')
+    # call third party api...
+    SimpleResponse.success(posts: posts, retrieval_time: retrieval_time)
+  rescue ThirdPartyAPI::CredentialsError => e
+    SimpleResponse.failure(error_message: 'invalid credentials')
+  end
+end
+```
+
+## Why?
+
+By using Response Objects you will be able to reduce the number and difficulty of your bugs because you will be easing the communication between your application layers that is where bugs used to come from.
 
-TODO: Delete this and the text above, and describe your gem
+SimpleResponse's proposal is a lightweight <a href="http://rubyonrails.org/doctrine/#beautiful-code" target="_blank">syntactic sugar for your response objects</a>.
 
 ## Installation
 
@@ -24,7 +60,7 @@ Or install it yourself as:
 
 ## Usage
 
-Example of how to create a success response object:
+Create a success response object:
 
 ```ruby
 response = SimpleResponse.success(user_id: 1)
@@ -34,20 +70,41 @@ response.user_id  # 1
 response.failure? # false
 ```
 
-## Development
+Create a failure response object:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+response = SimpleResponse.failure(user_id: 1)
+
+response.success? # false
+response.user_id  # 1
+response.failure? # true
+```
+
+You also have automatically query methods on boolean attributes:
+
+```
+response.works = true
+response.works  # true
+response.works? # true
+```
+
+To define dynamically the response status you could call directly the method new on SimpleResponse's class:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+SimpleResponse.new(success: true)
+
+# with custom data:
+SimpleResponse.new(success: true, user_id: 1)
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_response. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/giovannibenussi/simple_response. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+<!-- ## Code of Conduct
 
-Everyone interacting in the SimpleResponse project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/simple_response/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the SimpleResponse project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/giovannibenussi/simple_response/blob/master/CODE_OF_CONDUCT.md). -->

data/lib/simple_response/query_methods.rb

@@ -0,0 +1,21 @@
+module SimpleResponse
+  module QueryMethods
+    def existing_query_method?(name)
+      return false unless query_method?(name)
+      return false unless respond_to?(name[0...-1])
+
+      attribute_class = send(name[0...-1]).class
+      attribute_class == TrueClass || attribute_class == FalseClass
+    end
+
+    private
+
+    def query_method?(name)
+      name[-1] == '?'
+    end
+
+    def query_method(name)
+      send(name[0...-1])
+    end
+  end
+end

data/lib/simple_response/response.rb

@@ -1,7 +1,9 @@
 module SimpleResponse
   require 'ostruct'
+  require 'simple_response/query_methods'
+  require 'simple_response/simple_struct'
 
-  class Response < OpenStruct
+  class Response < SimpleStruct
     def initialize(success:)
       super
       self.success = success
@@ -15,22 +17,8 @@ module SimpleResponse
       !success?
     end
 
-    def method_missing(name, *args, &block)
-      if existing_query_method?(name)
-        send(name[0...-1])
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(name, include_private = false)
-      existing_query_method?(name)
-    end
-
-    private
-
-    def existing_query_method?(name)
-      name[-1] == '?' && respond_to?(name[0...-1])
+    def keys
+      to_h.keys
     end
   end
 end

data/lib/simple_response/simple_struct.rb

@@ -0,0 +1,17 @@
+module SimpleResponse
+  class SimpleStruct < OpenStruct
+    include SimpleResponse::QueryMethods
+
+    def method_missing(name, *args, &block)
+      if existing_query_method?(name)
+        query_method(name)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      existing_query_method?(name)
+    end
+  end
+end

data/lib/simple_response/version.rb

@@ -1,3 +1,3 @@
 module SimpleResponse
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_response
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Giovanni Benussi
@@ -71,7 +71,9 @@ files:
 - bin/console
 - bin/setup
 - lib/simple_response.rb
+- lib/simple_response/query_methods.rb
 - lib/simple_response/response.rb
+- lib/simple_response/simple_struct.rb
 - lib/simple_response/version.rb
 - simple_response.gemspec
 homepage: https://github.com/giovannibenussi/simple-response