owen_wows 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 350daf847c4234fbc11cc470da764020347617de9c26b2d29443efbbb2abe9dc
-  data.tar.gz: b40c1531ff4040bb03267767d5e6b16081ebb7c212bc3ca0df230d51ee444f01
+  metadata.gz: 8e4eefc0a2ca043c6128f33e83874d5b875b9a5849be866ce56afcc240f1743f
+  data.tar.gz: 71a6089e6c1fbca6cb74f060ca18c72c9f47cbd8b8a7a861c27753060a265266
 SHA512:
-  metadata.gz: d11f8230b47724624e4ec59c3a00fccfa7b14e7c17dfec050b8f110854124bf1f97fec3b2b34900f0bcd3ec424592fa02b4744c9380196548473902a87c53a11
-  data.tar.gz: 3a8760dd7587565c222fef963cd5cad85aebbcb07b009bf90b4c8fd561c28d388ac50f2e7104cf9cd8d28c8f0ef0b895412053f552c95ba71d5eb4f65c9dfeba
+  metadata.gz: a9592fe3f749368f0696607d5fa34f1de88061412d424028008d7c70bbf0a8e2e7fd8f3c1bb2b2d3765f1fb34740ca3464d9f635d5d9bef02cd16081a47960a2
+  data.tar.gz: 1ad2ccd1e9036a6e126fd5ed221817daa6d58c4aded18a5d122cc3812af00259beca7e27ed361633ca03982520a2023b2d928c1245bd9f978d39b1f4848f2a4f

data/.gitignore

@@ -13,3 +13,4 @@
 # system / ide files
 .idea/
 .ruby-version
+*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    owen_wows (0.1.0)
+    owen_wows (0.2.0)
       faraday (= 2.2.0)
       hashie (= 5.0.0)
 

data/README.md

@@ -1,8 +1,6 @@
 # OwenWows
 
-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/owen_wows`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a Ruby API wrapper for the [Owen Wilson Random Wow API](https://owen-wilson-wow-api.herokuapp.com/).
 
 ## Installation
 
@@ -22,13 +20,45 @@ Or install it yourself as:
 
 ## Usage
 
-```azure
-client = OwenWows::Client.new()
-client.wows
-client.random_wow
-client.movies
-client.directors
-```
+    require 'owen_wows;
+    wows = OwenWows::Client.new
+    
+    # get a random wow
+    wows.random_wow
+
+    # list all wows
+    wows.list
+
+Each call returns an array of `OwenWows::Wow` objects.
+
+Some filter options:
+
+    # from year
+    wows.from_year("2000")
+
+    # with director
+    wows.with_director("wes anderson")
+
+    # wows in movie
+    wows.in_movie("Cars")
+
+    # by default, movie is an exact search
+    # specify exact: false to string search
+    wows.in_movie("Cars", exact: false)
+
+You can specify the maximum number of results returned in any filter by passing a `results` argument.
+
+    wows.in_movie("Cars", exact: false, results: 10)
+
+Otherwise, you can search by any combination of parameters.
+
+    wows.search(movie: "Cars", year: "2000")
+
+Get lists of movies and directors.
+
+    wows.movies
+    wows.directors
+
 
 ## Development
 
@@ -38,7 +68,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/owen_wows.
+Bug reports and pull requests are welcome on GitHub at https://github.com/iubkud/owen_wows.
 
 ## License
 

data/bin/console

@@ -11,7 +11,5 @@ require "owen_wows"
 # require "pry"
 # Pry.start
 
-client = OwenWows::Client.new()
-
 require "irb"
 IRB.start(__FILE__)

data/lib/owen_wows/client.rb

@@ -3,6 +3,8 @@
 require "faraday"
 require "owen_wows/wow"
 module OwenWows
+  # Class for handling the API connection to the
+  # Owen Wilson Random Wow API
   class Client
     BASE_URL = "https://owen-wilson-wow-api.herokuapp.com/wows/"
     CURRENT_MOVIE_COUNT = 91
@@ -22,23 +24,38 @@ module OwenWows
     end
 
     def list(results: CURRENT_MOVIE_COUNT)
-      wows = connection.get("random", { results: results }).body
-      wows.map { |wow| OwenWows::Wow.new(wow) }
+      wows = search(results: results)
+      build_list(wows)
     end
 
-    def with_director(director)
-      wows = connection.get("random", { director: director }).body
-      wows.map { |wow| OwenWows::Wow.new(wow) }
+    def random_wow
+      wow = search
+      build_list(wow)
+    end
+
+    def with_director(director, results: CURRENT_MOVIE_COUNT)
+      wows = search(director: director, results: results)
+      build_list(wows)
+    end
+
+    def from_year(year, results: CURRENT_MOVIE_COUNT)
+      wows = search(year: year, results: results)
+      build_list(wows)
     end
 
     def in_movie(movie, exact: true, results: CURRENT_MOVIE_COUNT)
-      wows = connection.get("random", { movie: movie, results: results }).body
-      all = wows.map { |wow| OwenWows::Wow.new(wow) }
+      wows = search(movie: movie, results: results)
+      all = build_list(wows)
       return all unless exact
 
       all.select { |wow| wow["movie"] == movie }
     end
 
+    def search(**kwargs)
+      wows = connection.get("random", **kwargs).body
+      build_list(wows)
+    end
+
     def all_movies
       connection.get("movies").body
     end
@@ -46,5 +63,11 @@ module OwenWows
     def all_directors
       connection.get("directors").body
     end
+
+    private
+
+    def build_list(wows)
+      wows.map { |wow| OwenWows::Wow.new(wow) }
+    end
   end
-end
+end

data/lib/owen_wows/error.rb

@@ -2,4 +2,4 @@
 
 module OwenWows
   class Error < StandardError; end
-end
+end

data/lib/owen_wows/version.rb

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

data/lib/owen_wows.rb

@@ -5,5 +5,4 @@ require_relative "owen_wows/version"
 module OwenWows
   autoload :Client, "owen_wows/client"
   autoload :Error, "owen_wows/error"
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: owen_wows
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Barry