ac 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2cc120a06ba1dff33147f685d63b31df8c04a7616b9e5877e3c88c94f176e10
-  data.tar.gz: '0499e0f3109d6f84e8e2a0e2763733bd160ee643274060636db5de84a72adfc3'
+  metadata.gz: c0168d5bdf01a61dce4822daa18b9220e7206e054d8eb221e35f44960132a872
+  data.tar.gz: 55e1ff51ba10f2fcd774cec1076776d2e878892d64a61794e0d81864294754b8
 SHA512:
-  metadata.gz: 77ffa28676c9caa0c35c8990d19a130d4232a165275e66eb93dee74899554779186a1aa9384bb8fe34a0f22da5c28e4e1b50e0a86fe4b37dd5ce3713c714928e
-  data.tar.gz: fd089b550c29d87f8a68056d69f05518dc20dd6473a822fa03f6cdf14caba9e948ec29901321d73664b02f8ddddc928f6f6075fa13552916f9b05ce6e4929641
+  metadata.gz: a5ebe2c76798b8e089c1a9cd382f8a52d9517ba6d41c7fb1285b5ecf489d20c0cc60fc967afc4154cd676a79e4491fc15eca1d609ea8890aa503252eb5bb6d9e
+  data.tar.gz: 70b22d0c9746b6e85fb4d8bef1d15c7f75b00b8e226c449d8c8c28127bf71d7fd5ed629cfeb54ed137345af0dbb9c79cee937b9b7e9506bc89e9762789bc8977

data/README.md

@@ -1,39 +1,51 @@
 # Ac
+Api Client for Typhoeus
 
-TODO: Delete this and the text below, and describe your gem
-
-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/ac`. To experiment with that code, run `bin/console` for an interactive prompt.
+### Features
+- defines convenience methods for get, post, put, patch, and delete
+- allows passing a block to the convenience mehtods to handle retry logic
+- prepends a module to Typhoeus::Response that provides a `.json` method that returns parsed JSON or `nil` if parsing fails.
 
 ## Installation
+Add `gem "ac"` to your Gemfile or install it yourself with `gem install ac`.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
 
 ## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
+Subclass Ac::Base and define BASE_URL, then you can use `get(path, options)` (or put/patch/delete).
+```ruby
+class HttpbinClient < Ac::Base
+  BASE_URL = "https://httpbin.org"
+
+  def my_ip_address
+    get("/ip").json["origin"]
+  end
+end
+
+client = HttpbinClient.new
+puts client.my_ip_address
+# => 177.62.72.86
+```
+Implement retries by passing a block that blows up or retruns false if the resquest should be retried.
+```ruby
+class JsonPlaceholderClient < Ac::Base
+  BASE_URL = "https://jsonplaceholder.typicode.com"
+
+  def find_post id
+    res = get("posts/#{id}") do |response|
+      Integer(response.json["id"])
+    end
+    res.json
+  end
+end
+
+client = JsonPlaceholderClient.new
+puts client.find_post 2
+# => {"userId"=>1, "id"=>2, "title"=>"qui est esse", "body"=>"est rerum tempore vi...
+```
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ac. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ac/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/felipedmesquita/ac.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Ac project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ac/blob/main/CODE_OF_CONDUCT.md).

data/ac.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/ac/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ac"
+  spec.version = Ac::VERSION
+  spec.authors = ["felipedmesquita"]
+  spec.email = ["16197684+felipedmesquita@users.noreply.github.com"]
+
+  spec.summary = "Api Client for Typhoeus"
+  spec.homepage = "https://github.com/felipedmesquita/ac"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/felipedmesquita/ac"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ mini_mock/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "typhoeus"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/ac/base.rb

@@ -23,7 +23,7 @@ module Ac
 
       define_method http_verb do |path, options = {}, &block|
         retries_count ||= 0
-        raise "Too many retries" if retries_count > MAX_RETRIES
+        raise "Too many retries" if retries_count > self.class::MAX_RETRIES
         # puts "Requesting #{path}, retry number #{retries_count}"
         response = send("#{http_verb}_request", path, options).run
 
@@ -32,6 +32,7 @@ module Ac
             raise unless block.call(response)
           rescue
             retries_count += 1 # standard:disable Lint/UselessAssignment
+            sleep(2**retries_count)  # Exponential backoff
             redo
           end
         end

data/lib/ac/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ac
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ac
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - felipedmesquita
@@ -35,6 +35,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- ac.gemspec
 - lib/ac.rb
 - lib/ac/base.rb
 - lib/ac/json_patch.rb
@@ -63,5 +64,5 @@ requirements: []
 rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
-summary: Simple Api Client for Typhoeus
+summary: Api Client for Typhoeus
 test_files: []