liblab_the_one 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 741e0a412dd8d819491fdf28c9f39f34a55a82ed0ef46e09a451146892e4e110
-  data.tar.gz: 708aa4fc97a346afe379f2442e74e1c01d3a680476b701469357d3394daf28d5
+  metadata.gz: 26956ba91f4879a09844057d5b0738c308793845c10bf181d2f0772ad534743a
+  data.tar.gz: ffacc57af7e65676ed63a5ec1723273b7134ae4d3a8c9b16c9f46875651b4d7a
 SHA512:
-  metadata.gz: 6ee78d19db8cd207d26fc4e291d4e7c29a03d46a143a35f098d684a448aa3a82f41d2e54f647c385062e921ad3e578dcdab7f8c18a54dce7baceaf23cd6dee2d
-  data.tar.gz: 1e91ddc7dc02c8950dfb4b347246dd4204ba315b8e59ba2f68d29f6ddd3bdf26f302266b6124f6d7021d9396feb84a4ee0773d7fc2c715483a99e841d6369119
+  metadata.gz: e98bdb3e2251d0233407bc2738c62ecebc50455fdde8cf37e6bd195f132692ce269df0be97f565c34d4cfa20e8af2ab04331fc3734b0cd0d872cc2fcf70a8d5b
+  data.tar.gz: e461d819b73aaa5faf06888b96891ba4231eac84435b6d92f68086b8828a0b68e131e7f12547061036efa4b1202e7176e81fa778ab173f750e4c8df253ab7fc5

data/Gemfile.lock

@@ -1,15 +1,13 @@
 PATH
   remote: .
   specs:
-    liblab_the_one (0.1.0)
-      pry (~> 0.14.2)
+    liblab_the_one (0.3.0)
       rest-client (~> 2.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    coderay (1.1.3)
     diff-lcs (1.5.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
@@ -17,7 +15,6 @@ GEM
     http-cookie (1.0.5)
       domain_name (~> 0.5)
     json (2.6.3)
-    method_source (1.0.0)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2023.0218.1)
@@ -25,9 +22,6 @@ GEM
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.0)

data/README.md

@@ -4,6 +4,14 @@ This gem is an API wrapper for (the one api)[https://the-one-api.dev/].
 
 ## Installation
 
+Install `ruby` and `bundler`
+
+Add the following environment variables. You can request an `access_token` at https://the-one-api.dev/.
+
+```
+  LIBLAB_ACCESS_TOKEN=
+```
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -17,6 +25,8 @@ And then execute:
 Or install it yourself as:
 
     $ gem install pex_api
+    
+After installing you can test by running `irb`, then `require "liblab"` and then running `Liblab::Movie::List.call()` This should return a list of movies.
 
 ## Usage
 `Liblab::Movie::List.call()` will get a list of movies
@@ -31,15 +41,16 @@ Or install it yourself as:
 
 `Liblab::Quote::Get.call(quote_id)` will retrieve an individual quote
 
-Each class/method will have it's own parameters depending on the type of request and it's expected input parameters.
 
-### Setup
+## Bonus Game: Guess the quote!
 
-Add the following environment variables. The specific values can be found at https://the-one-api.dev/.
+Help test and build your Lord of The Rings knowledge.
 
-```
-  LIBLAB_ACCESS_TOKEN=
-```
+Use `Liblab::Quote::GuessTheQuote.call()` to return a random quote with a movie name. 
+
+You can tell people the quote and they have to guess the movie.
+
+Example response is `{:quote=>"Your bodyguard?", :movie_name=>"The Two Towers"}`
 
 ## Development
 

data/design.md

@@ -0,0 +1,19 @@
+# Liblab one API SDK design
+
+This is a `ruby gem` implementation. The gem was bootstrapped with `Bundler`.
+
+The file structure follows standard file structure design stated by https://guides.rubygems.org/make-your-own-gem/. and https://bundler.io/guides/creating_gem.html
+
+There is an `https helper class` to help with error handling.
+
+`client/base` handles the actual api request preparation and calling.
+
+There is a configuration file to allow for the `access token` to be added via an environment variable.
+
+There is a custom `logging` system to debug requests. 
+
+`Rspec` was used for automated testing and tests all implemented endpoints and possible failures. 
+
+Each class contains a command for an endpoint request. This follows a `service object` approach with a `call` method to trigger the request. https://www.toptal.com/ruby-on-rails/rails-service-objects-tutorial
+
+`Pagination` was also implemented for quotes list.

data/lib/liblab/quote/guess_the_quote.rb

@@ -0,0 +1,34 @@
+module Liblab
+  module Quote
+    class GuessTheQuote
+
+      # Example returns {:quote=>"Your bodyguard?", :movie_name=>"The Two Towers"}
+
+      def self.call()
+        page = rand(2)
+        _path = "quote?page=#{page}"
+
+        # Get a random page of quotes
+        quote_result = ::Liblab::Client::Base.new.get(_path)
+
+        if quote_result.code == 200
+          # Get a random quote from returned quotes
+          index = rand(999)
+          quote = JSON.parse(quote_result.body)["docs"][index]
+          movie_result = ::Liblab::Movie::Get.call(quote["movie"])
+
+          if movie_result.code == 200
+            # Get movie name for the selected quote
+            movie = JSON.parse(movie_result.body)["docs"][0]
+
+            return { quote: quote["dialog"], movie_name: movie["name"] }
+          else
+            return { error: "Could not get movie_result", message: movie_result.body }
+          end
+        else
+          return { error: "Could not get quote", message: quote_result.body }
+        end
+      end
+    end
+  end
+end

data/lib/liblab/version.rb

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

data/lib/liblab.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "pry"
 require_relative "liblab/version"
 require_relative "liblab/configuration"
 require_relative "liblab/https"
@@ -11,6 +10,7 @@ require_relative "liblab/movie/get"
 require_relative "liblab/movie/get_quotes"
 require_relative "liblab/quote/list"
 require_relative "liblab/quote/get"
+require_relative "liblab/quote/guess_the_quote"
 
 module Liblab
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: liblab_the_one
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Monty Lennie
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.2
 description: Allows easy connection to liblab API
 email:
 - montylennie@gmail.com
@@ -54,6 +40,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- design.md
 - lib/liblab.rb
 - lib/liblab/client/base.rb
 - lib/liblab/configuration.rb
@@ -63,6 +50,7 @@ files:
 - lib/liblab/movie/get_quotes.rb
 - lib/liblab/movie/list.rb
 - lib/liblab/quote/get.rb
+- lib/liblab/quote/guess_the_quote.rb
 - lib/liblab/quote/list.rb
 - lib/liblab/version.rb
 - sig/liblab.rbs