swapi_dev 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '009142a54f57b5635f5dfdd7c4b91a78929c64826e4db1ce7feb7821a6f8447d'
-  data.tar.gz: c9394eb3c74fe0a50c66159fd29c35c829532df41d087330b9da169f4432e84f
+  metadata.gz: db3388dec99bb707aa6cd6195324026c7d04e5b58cfbefc0497a6a6d3d8ee359
+  data.tar.gz: 44889a89dd93ccbc6130f0d370ab8e98b7f0299beacf22bdadc6954042bda680
 SHA512:
-  metadata.gz: a223909ee91cc5d85f42db39d0188a1bdb0624e518a7070d0ed125a88453ed265f09ae5af680d263f6f5f6da9dde66100039700bb64c83931a994ed5b912588a
-  data.tar.gz: dd33feb0faf9e65be53a0c3200ff4db27ceea15e21c8e349c299432faf9a9dc46664db898b63fef933220494a67f2efeef7d1234089e83040cfb426fa0818b65
+  metadata.gz: 69aba0fa1e974d42bd588329582d1ff1bef97036262ab265397dacc01601bb8c6980fa316d37979c933f477a18489a4d245f545ee70253bd30b4b7419de3f630
+  data.tar.gz: efe9a2c1a9cd253488896607ed8e1d24557d3613502d2f9e7a4fdf86749edebe17e1549943ce9bf2f316a3713106e567a376661ed544bfe189302cd9bef124ff

data/.rubocop.yml

@@ -0,0 +1,26 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*.rb'
+    - 'node_modules/**/*'
+    - 'vendor/**/*'
+    - 'log/**/*'
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-08-04 03:37:09 UTC using RuboCop version 1.55.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 36
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: implicit, explicit
+Style/RescueStandardError:
+  Exclude:
+    - 'lib/swapi_dev/serializers/error_serializer.rb'

data/CHANGELOG.md

@@ -3,3 +3,15 @@
 ## [0.1.0] - 2021-12-29
 
 - Initial release
+
+## [1.0.0] - 2023-08-14
+
+- Update minimun ruby version (3.0.0)
+- Update development dependencies
+- Change linter gem
+- apply some KISS coding 😘
+- update readme
+- remove not necessary methods
+## [1.0.1] - 2023-08-14
+
+- update release date 😅

data/Gemfile

@@ -4,11 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in swapi_dev.gemspec
 gemspec
-
-gem "minitest", "~> 5.0"
-gem "rake", "~> 13.0"
-gem "standardrb", "~> 1.0"
-
-group :test do
-  gem "webmock"
-end

data/README.md

@@ -2,6 +2,10 @@
 
 A Ruby wrapper for the Star Wars API
 
+# RubyGem
+
+[https://rubygems.org/gems/swapi_dev](https://rubygems.org/gems/swapi_dev)
+
 
 # Api documentation
 here is the documentation of [The Star War API](https://swapi.dev/)
@@ -31,56 +35,78 @@ require "swapi_dev"
 
 ## Methods
 
-There is 6 diferents statistics to request
-### People
-
-```ruby
-SwapiDev.people_all
-SwapiDev.people_id(id)
-SwapiDev.people_name(name)
-```
-
-### Films
+You will find methods for 6 diferent Resources, all of them with the same behavior:
+- Planets
+- Starships
+- Vehicles
+- People
+- Films
+- Species
+#### Example using People
 
 ```ruby
-SwapiDev.film_all
-SwapiDev.film_id(id)
-SwapiDev.film_title(title)
+SwapiDev.people # accepts: format, page, search
+SwapiDev.people_id(some_id) # accepts: format
 ```
 
-### Planets
+## Searching
+All searches will use case-insensitive partial matches on the set of search fields.
 
 ```ruby
-SwapiDev.planet_all
-SwapiDev.planet_id(id)
-SwapiDev.planet_name(name)
+# people search
+SwapiDev.people(search: "Luke Skywalker")
+# vehicle search
+SwapiDev.vehicle(search: "Sand Crawler")
 ```
 
-### Species
+To see the set of search fields for each resource, check the table below:
+
+<table>
+  <tr>
+    <td><b>Resource</b></td>
+    <td><b>Fields</b></td>
+  </tr>
+  <tr>
+    <td>People</td>
+    <td>name</td>
+  </tr>
+  <tr>
+    <td>Films</td>
+    <td>title</td>
+  </tr>
+  <tr>
+    <td>Starships</td>
+    <td>name, model</td>
+  </tr>
+  <tr>
+    <td>Vehicles</td>
+    <td>name, model</td>
+  </tr>
+  <tr>
+    <td>Species</td>
+    <td>name</td>
+  </tr>
+  <tr>
+    <td>Planets</td>
+    <td>name</td>
+  </tr>
+</table>
+
+## Pagination
+You can pass a `page` argument if you want to get specific page.
 
 ```ruby
-SwapiDev.specie_all
-SwapiDev.specie_id(id)
-SwapiDev.specie_name(name)
+SwapiDev.people(page: 2)
 ```
 
-### Starships
-
+## Format
+This encoding is identical to JSON except with wookiee translations. All methods accept wookiee format keyword.
 ```ruby
-SwapiDev.starship_all
-SwapiDev.starship_id(id)
-SwapiDev.starship_name(name)
-SwapiDev.starship_model(model)
+SwapiDev.people(format: :wookie)
+SwapiDev.people(search: "Luke", format: :wookie)
+SwapiDev.people_id(1, format: :wookie)
 ```
 
-### Vehicles
-
-```ruby
-SwapiDev.vehicle_all
-SwapiDev.vehicle_id(id)
-SwapiDev.vehicle_name(name)
-SwapiDev.vehicle_model(model)
-```
 
 ## Contributing
 

data/lib/swapi_dev/client/client.rb

@@ -9,19 +9,7 @@ module SwapiDev
     end
 
     def get(resource, **args)
-      request(resource, **args) { |uri| Net::HTTP::Get.new(uri) }
-    end
-
-    def post(resource, **args)
-      request(resource, **args) { |uri| Net::HTTP::Post.new(uri) }
-    end
-
-    def put(resource, **args)
-      request(resource, **args) { |uri| Net::HTTP::Put.new(uri) }
-    end
-
-    def delete(resource, **args)
-      request(resource, **args) { |uri| Net::HTTP::Delete.new(uri) }
+      request(resource, **args) { Net::HTTP::Get.new(_1) }
     end
 
     private
@@ -32,10 +20,9 @@ module SwapiDev
       uri = uri_builder.build(resource, **args)
       http_response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
         request = yield(uri)
-        request["Content-Type"] = "application/json" if request.instance_of?(Net::HTTP::Put) || request.instance_of?(Net::HTTP::Post)
         http.request(request)
       end
-      Response.handle(http_response, **args)
+      Response.handle(http_response)
     end
   end
 end

data/lib/swapi_dev/client/endpoint.rb

@@ -6,36 +6,12 @@ module SwapiDev
       @client = Client.new("https://swapi.dev/api/")
     end
 
-    def all
-      response = client.get(resource)
-      return response if response[:next].nil?
-
-      range = (2..(response[:count] / 10.0).ceil)
-      response[:results] + AsyncStream.new(range).sum { |page| list(page) }
-    end
-
-    def list(page = nil)
-      client.get(resource, page: page)[:results]
-    end
-
-    def find(id)
-      client.get("#{resource}/#{id}")
-    end
-
-    def search(field)
-      client.get(resource, search: field.to_s)
-    end
-
-    def update(**data)
-      client.put(resource, **data)
-    end
-
-    def create(**data)
-      client.post(resource, **data)
+    def all(**args)
+      client.get("#{resource}/", **args)
     end
 
-    def delete(**data)
-      client.delete(resource, **data)
+    def find_id(id, **args)
+      client.get("#{resource}/#{id}/", **args)
     end
 
     private

data/lib/swapi_dev/client/response.rb

@@ -2,14 +2,9 @@
 
 module SwapiDev
   class Response
-    def self.handle(http_response, **args)
-      serializer = args[:format] == "wookiee" ? WookieeSerializer : JsonSerializer
-
-      case http_response
-      when Net::HTTPSuccess
-        serializer.call(http_response.body)
-      when Net::HTTPOK
-        serializer.call(http_response.body)
+    def self.handle(http_response)
+      if [Net::HTTPSuccess, Net::HTTPOK].member? http_response.class
+        JsonSerializer.call(http_response.body)
       else
         ErrorSerializer.call(http_response)
       end

data/lib/swapi_dev/client/uri_builder.rb

@@ -8,7 +8,7 @@ module SwapiDev
 
     def build(resource, **options)
       uri = URI.join(@base_url, resource)
-      uri.query = URI.encode_www_form(options.slice(:format, :search, :page))
+      uri.query = URI.encode_www_form(options.slice(:search, :page, :format))
       yield if block_given?
       uri
     end

data/lib/swapi_dev/serializers/error_serializer.rb

@@ -12,7 +12,11 @@ module SwapiDev
         }
       )
     rescue
-      nil
+      {
+        message: content.message,
+        code: content.code,
+        detail: "Try without format or page"
+      }
     end
   end
 end

data/lib/swapi_dev/version.rb

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

data/lib/swapi_dev.rb

@@ -11,7 +11,6 @@ require_relative "swapi_dev/client/async_stream"
 require_relative "swapi_dev/serializers/base_serializer"
 require_relative "swapi_dev/serializers/error_serializer"
 require_relative "swapi_dev/serializers/json_serializer"
-require_relative "swapi_dev/serializers/wookiee_serializer"
 
 require_relative "swapi_dev/resources/people"
 require_relative "swapi_dev/resources/starship"
@@ -23,83 +22,51 @@ require_relative "swapi_dev/resources/specie"
 module SwapiDev
   class Error < StandardError; end
 
-  def self.people_all
-    People.new.all
+  def self.people(**args)
+    People.new.all(**args)
   end
 
-  def self.people_id(id)
-    People.new.find(id)
+  def self.people_id(id, **args)
+    People.new.find_id(id, **args.slice(:format))
   end
 
-  def self.people_name(name)
-    People.new.search(name)
+  def self.films(**args)
+    Film.new.all(**args)
   end
 
-  def self.film_all
-    Film.new.all
+  def self.film_id(id, **args)
+    Film.new.find_id(id, **args.slice(:format))
   end
 
-  def self.film_id(id)
-    Film.new.find(id)
+  def self.planets(**args)
+    Planet.new.all(**args)
   end
 
-  def self.film_title(name)
-    Film.new.search(name)
+  def self.planet_id(id, **args)
+    Planet.new.find_id(id, **args.slice(:format))
   end
 
-  def self.planet_all
-    Planet.new.all
+  def self.species(**args)
+    Specie.new.all(**args)
   end
 
-  def self.planet_id(id)
-    Planet.new.find(id)
+  def self.specie_id(id, **args)
+    Specie.new.find_id(id, **args.slice(:format))
   end
 
-  def self.planet_name(name)
-    Planet.new.search(name)
+  def self.starships(**args)
+    Starship.new.all(**args)
   end
 
-  def self.specie_all
-    Specie.new.all
+  def self.starship_id(id, **args)
+    Starship.new.find_id(id, **args.slice(:format))
   end
 
-  def self.specie_id(id)
-    Specie.new.find(id)
+  def self.vehicles(**args)
+    Vehicle.new.all(**args)
   end
 
-  def self.specie_name(name)
-    Specie.new.search(name)
-  end
-
-  def self.starship_all
-    Starship.new.all
-  end
-
-  def self.starship_id(id)
-    Starship.new.find(id)
-  end
-
-  def self.starship_name(name)
-    Starship.new.search(name)
-  end
-
-  def self.starship_model(model)
-    Starship.new.search(model)
-  end
-
-  def self.vehicle_all
-    Vehicle.new.all
-  end
-
-  def self.vehicle_id(id)
-    Vehicle.new.find(id)
-  end
-
-  def self.vehicle_name(name)
-    Vehicle.new.search(name)
-  end
-
-  def self.vehicle_model(model)
-    Vehicle.new.search(model)
+  def self.vehicle_id(id, **args)
+    Vehicle.new.find_id(id, **args.slice(:format))
   end
 end

data/swapi_dev.gemspec

@@ -12,7 +12,13 @@ Gem::Specification.new do |spec|
   spec.description = "Ruby wrapper for The Star Wars API"
   spec.homepage = "https://github.com/Eduardo-Lpz/swapi_dev"
   spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = "~> 3.0.0"
+
+  spec.add_development_dependency "minitest", "~> 5.19"
+  spec.add_development_dependency "rake", "~> 13.0", ">= 13.0.6"
+  spec.add_development_dependency "rubocop", "~> 1.55", ">= 1.55.1"
+  spec.add_development_dependency "simplecov", "~> 0.22.0"
+  spec.add_development_dependency "webmock", "~> 3.18", ">= 3.18.1"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 

metadata

@@ -1,15 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: swapi_dev
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Eduardo Lopez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
-dependencies: []
+date: 2023-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.19'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.55'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.55.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.55'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.55.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.18.1
 description: Ruby wrapper for The Star Wars API
 email:
 - jramos@arkusnexus.com
@@ -18,10 +106,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -42,7 +131,6 @@ files:
 - lib/swapi_dev/serializers/base_serializer.rb
 - lib/swapi_dev/serializers/error_serializer.rb
 - lib/swapi_dev/serializers/json_serializer.rb
-- lib/swapi_dev/serializers/wookiee_serializer.rb
 - lib/swapi_dev/version.rb
 - swapi_dev.gemspec
 homepage: https://github.com/Eduardo-Lpz/swapi_dev
@@ -56,16 +144,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: SWAPI Wrapper

data/Gemfile.lock

@@ -1,61 +0,0 @@
-PATH
-  remote: .
-  specs:
-    swapi_dev (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    crack (0.4.5)
-      rexml
-    hashdiff (1.0.1)
-    minitest (5.15.0)
-    parallel (1.21.0)
-    parser (3.0.3.2)
-      ast (~> 2.4.1)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.2.0)
-    rexml (3.2.5)
-    rubocop (1.23.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.0)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.12.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    standard (1.5.0)
-      rubocop (= 1.23.0)
-      rubocop-performance (= 1.12.0)
-    standardrb (1.0.0)
-      standard
-    unicode-display_width (2.1.0)
-    webmock (3.14.0)
-      addressable (>= 2.8.0)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-
-PLATFORMS
-  x86_64-darwin-21
-
-DEPENDENCIES
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  standardrb (~> 1.0)
-  swapi_dev!
-  webmock
-
-BUNDLED WITH
-   2.2.15

data/lib/swapi_dev/serializers/wookiee_serializer.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-module SwapiDev
-  class WookieeSerializer < BaseSerializer
-    def self.call(content)
-      # this encoding is identical to JSON except with wookiee translations.
-      # for some reason json does not work
-      # TODO Wookie transalation
-      JSON.parse(content, symbolize_names: true)
-    rescue JSON::ParserError
-      nil
-    end
-  end
-end