simple_advice 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cc4699756da14544d1b61e55a8a20c809565df5a21dd075a92c0e0cf6445bc7
+  data.tar.gz: 65f1a69af6637c28a9c5eddc4e3dcceba34762ad207fb9319c587da342b34189
+SHA512:
+  metadata.gz: 12ed08d5e6a436c6147dbae7f19ab0d9bae029f224870b9053290e7d23b0c5f7c232a32aef704945126541b12d8c95bd340efc53cb23b0a2596f83bb49029134
+  data.tar.gz: b0c3ac08d1017e1d9ee7f3baab4cc85e018224bd78d2465a1579d96cbb23feb2b55473eb758650ce702adce389edd90ec89aa40ffe821121b0414f9cc113d35c

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/OpenStructUse:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simple_advice.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    simple_advice (0.1.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    minitest (5.15.0)
+    multipart-post (2.1.1)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rubocop (1.27.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-darwin-21
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  simple_advice!
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Dmytro Havrysh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# SimpleAdvice [![Build Status](https://app.travis-ci.com/DmytroHavryshGoTo/simple_advice.svg?branch=main)](https://app.travis-ci.com/DmytroHavryshGoTo/simple_advice)
+
+Implementation of [Advice Slip JSON API](https://api.adviceslip.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_advice'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simple_advice
+
+## Usage
+
+Everthing is as simple as it could be.
+
+### Get random advice
+```ruby
+rnd = SimpleAdvice.random # => #<SimpleAdvice::Advice>
+
+rnd.id # => 77
+rnd.advice # => "Mercy is the better part of justice."
+```
+
+### Find advice by id
+
+```ruby
+SimpleAdvice.find(advice_id: 77) # => #<SimpleAdvice::Advice>
+```
+
+### Find advice by text
+
+```ruby
+result = SimpleAdvice.find_by(query: "nice") # => #<SimpleAdvice::Collection> 
+
+result.data # => [#<SimpleAdvice::Advice>]
+
+result.total # => 1
+```
+
+## Config
+
+SimpleAdvice uses Faraday to interact via HTTP, you can provide any HTTP adapter that Faraday supports(if you are using Rails put the following code into `initializers/simple_advice.rb`):
+
+```ruby
+SimpleAdvice::Config.http_adapter = :test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DmytroHavryshGoTo/simple_advice.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/simple_advice/client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SimpleAdvice
+  class Client
+    BASE_URL = "https://api.adviceslip.com"
+
+    class << self
+      def get_request(url, params: {}, headers: {})
+        handle_response connection.get(url, params, headers)
+      end
+
+      private
+
+      def connection
+        Faraday.new(BASE_URL) do |conn|
+          conn.request :json
+          # Can't use because the response is always text/html format and when 500 error happens it crashes
+          # conn.response :json
+          conn.adapter Config.http_adapter, Config.stubs
+        end
+      end
+
+      def handle_response(response)
+        case response.status
+        when 400
+          raise Error, "Your request was malformed."
+        when 404
+          raise Error, "No results were found for your request."
+        when 429
+          raise Error, "Your request exceeded the API rate limit."
+        when 500
+          raise Error, "We were unable to perform the request due to server-side problems."
+        when 503
+          raise Error, "You have been rate limited for sending more than 20 requests per second."
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/simple_advice/collection.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SimpleAdvice
+  class Collection
+    attr_reader :data, :total
+
+    def self.from_response(response, key:, type:)
+      body = JSON.parse(response.body)
+      data = body[key]
+      return new(data: [], total: 0) unless data
+
+      new(
+        data: data.map { |attrs| type.new(attrs) },
+        total: body["total_results"].to_i
+      )
+    end
+
+    def initialize(data:, total:)
+      @data = data
+      @total = total
+    end
+  end
+end

data/lib/simple_advice/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SimpleAdvice
+  class Config
+    @http_adapter = Faraday.default_adapter
+
+    class << self
+      attr_accessor :http_adapter, :stubs
+    end
+  end
+end

data/lib/simple_advice/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleAdvice
+  class Error < StandardError; end
+end

data/lib/simple_advice/object.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module SimpleAdvice
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_struct(attributes)
+    end
+
+    def to_struct(obj)
+      case obj
+      when is_a?(Hash)
+        OpenStruct.new(obj.transform_values(&:to_ostruct))
+      when is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else
+        obj
+      end
+    end
+  end
+end

data/lib/simple_advice/objects/advice.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleAdvice
+  class Advice < Object; end
+end

data/lib/simple_advice/version.rb

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

data/lib/simple_advice.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+require_relative "simple_advice/version"
+
+module SimpleAdvice
+  autoload :Config, "simple_advice/config"
+  autoload :Client, "simple_advice/client"
+  autoload :Collection, "simple_advice/collection"
+  autoload :Error, "simple_advice/error"
+  autoload :Object, "simple_advice/object"
+
+  # Classes used to return a nicer object wrapping the response data
+  autoload :Advice, "simple_advice/objects/advice"
+
+  class << self
+    def random
+      Advice.new JSON.parse(Client.get_request("advice").body)["slip"]
+    end
+
+    def find(advice_id:)
+      advice_obj = JSON.parse(Client.get_request("advice/#{advice_id}").body)["slip"]
+      advice_obj ? Advice.new(advice_obj) : nil
+    end
+
+    def find_by(query:)
+      Collection.from_response(Client.get_request("advice/search/#{query}"), key: "slips", type: Advice)
+    end
+  end
+end

data/simple_advice.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/simple_advice/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "simple_advice"
+  spec.version = SimpleAdvice::VERSION
+  spec.authors = ["Dmytro Havrysh"]
+  spec.email = ["dmytro.havrysh1@gmail.com"]
+
+  spec.summary = "Implementation of Advice Slip JSON API"
+  spec.description = "Easily get an advice"
+  spec.homepage = "https://github.com/DmytroHavryshGoTo/simple_advice"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: simple_advice
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmytro Havrysh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Easily get an advice
+email:
+- dmytro.havrysh1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_advice.rb
+- lib/simple_advice/client.rb
+- lib/simple_advice/collection.rb
+- lib/simple_advice/config.rb
+- lib/simple_advice/error.rb
+- lib/simple_advice/object.rb
+- lib/simple_advice/objects/advice.rb
+- lib/simple_advice/version.rb
+- simple_advice.gemspec
+homepage: https://github.com/DmytroHavryshGoTo/simple_advice
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DmytroHavryshGoTo/simple_advice
+  source_code_uri: https://github.com/DmytroHavryshGoTo/simple_advice
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Implementation of Advice Slip JSON API
+test_files: []