podcast_index 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be3811eb9cbde914e7e314e4d02e35a335fcb06250b8e22519ed0b59487d2e4b
-  data.tar.gz: 19de21d136dbc55f8cf0adcc65a710d773baceb99398ff22182d7e67b26ebc6b
+  metadata.gz: 1364632f70ac0a7504a90e90c5b6bd53d978697ecba73dc85bbbcddebe92706e
+  data.tar.gz: d495e5fdce0ce3baedb5ada68f4876f7e906c0dbfee655dc49df0681aad45601
 SHA512:
-  metadata.gz: 353f4074705cd1e93675d8bb8908698a57b07f321f54510d6d8e23af483736d6fd127b94aafcc67cd3d29e84e628c505aac290823e33425e30bc7c4343044cf8
-  data.tar.gz: 03075bb9e16b26edaa2b4d865435b0bdf919fd896f7b19e0b5c3f7d204cb0093a2f35e02d1312b2e0248c2a3385dbb54cd240a504b92afd1bbae3bb8d8a22d40
+  metadata.gz: f3b68defbe2c3640ac0ac63317a4838590304a296dabb786c43ebeb8b3eca4eba2aa90745e5857cc0b916e22c2e025a43dd4f991b0915185261c03b33f445aeb
+  data.tar.gz: dbd7f74e52c4e2f5c40d1ccdfad1bfb498b28d6ce3e14b8c32cb38cd1bc014bf21083ad3db05c0167979974a5c14be8889552fbb94c7bd168b324c327fcad7cf

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.3.0] - 2023-09-22
+
+* Add `max` parameter to search requests (thanks @lbrito1)
+
+## [0.2.1] - 2023-07-06
+
+* Raise exception when `Podcast.find` returns no result ([#6](https://github.com/jasonyork/podcast-index/issues/6))
+
 ## [0.2.0] - 2023-04-24
 
 * BREAKING: Switching to be more consistent with ActiveRecord conventions, using `find_by` and `where` methods for all models

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    podcast_index (0.2.0)
+    podcast_index (0.3.0)
       activesupport (>= 6.0, < 8)
       addressable (~> 2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3.1)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -27,13 +27,13 @@ GEM
     diff-lcs (1.5.0)
     docile (1.4.0)
     hashdiff (1.0.1)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     io-console (0.6.0)
     irb (1.6.2)
       reline (>= 0.3.0)
     json (2.6.3)
-    minitest (5.17.0)
+    minitest (5.20.0)
     parallel (1.22.1)
     parser (3.1.3.0)
       ast (~> 2.4.1)
@@ -86,7 +86,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
     webmock (3.14.0)

data/README.md

@@ -56,6 +56,16 @@ podcast = PodcastIndex::Podcast.find(920666)
 podcast.title # => "Podcasting 2.0"
 ```
 
+When the podcast cannot be found:
+
+```ruby
+begin
+  podcast = PodcastIndex::Podcast.find("invalid")
+rescue PodcastIndex::PodcastNotFound
+  puts "Podcast not found"
+end
+```
+
 Find an episode by guid:
 
 ```ruby

data/lib/podcast_index/api/search.rb

@@ -1,29 +1,34 @@
+# rubocop:disable Metrics/ParameterLists
 module PodcastIndex
   module Api
     class Search
       extend Request
 
       class << self
-        def by_term(term:, val: nil, aponly: nil, clean: nil, fulltext: nil)
-          response = get("/search/byterm", q: term, val: val, aponly: aponly, clean: clean, fulltext: fulltext)
+        def by_term(term:, val: nil, aponly: nil, clean: nil, fulltext: nil, max: nil)
+          response = get("/search/byterm", q: term, val: val, aponly: aponly, clean: clean, fulltext: fulltext,
+                                           max: max)
           JSON.parse(response.body)
         end
 
-        def by_title(title:, val: nil, clean: nil, fulltext: nil, similar: nil)
-          response = get("/search/bytitle", q: title, val: val, clean: clean, fulltext: fulltext, similar: similar)
+        def by_title(title:, val: nil, clean: nil, fulltext: nil, similar: nil, max: nil)
+          response = get("/search/bytitle", q: title, val: val, clean: clean, fulltext: fulltext, similar: similar,
+                                            max: max)
           JSON.parse(response.body)
         end
 
-        def by_person(person:, fulltext: nil)
-          response = get("/search/byperson", q: person, fulltext: fulltext)
+        def by_person(person:, fulltext: nil, max: nil)
+          response = get("/search/byperson", q: person, fulltext: fulltext, max: max)
           JSON.parse(response.body)
         end
 
-        def music_by_term(term:, val: nil, aponly: nil, clean: nil, fulltext: nil)
-          response = get("/search/music/byterm", q: term, val: val, aponly: aponly, clean: clean, fulltext: fulltext)
+        def music_by_term(term:, val: nil, aponly: nil, clean: nil, fulltext: nil, max: nil)
+          response = get("/search/music/byterm", q: term, val: val, aponly: aponly, clean: clean, fulltext: fulltext,
+                                                 max: max)
           JSON.parse(response.body)
         end
       end
     end
   end
 end
+# rubocop:enable Metrics/ParameterLists

data/lib/podcast_index/episode.rb

@@ -66,8 +66,8 @@ module PodcastIndex
         from_response_collection(response)
       end
 
-      def find_all_by_person(person:, fulltext: nil)
-        response = Api::Search.by_person(person: person, fulltext: fulltext)
+      def find_all_by_person(person:, fulltext: nil, max: nil)
+        response = Api::Search.by_person(person: person, fulltext: fulltext, max: max)
         from_response_collection(response)
       end
 

data/lib/podcast_index/podcast.rb

@@ -10,6 +10,8 @@ module PodcastIndex
 
       def find(id)
         response = Api::Podcasts.by_feed_id(id: id)
+        raise PodcastIndex::PodcastNotFound, response["description"] if response["feed"].empty?
+
         from_response(response)
       end
 
@@ -53,8 +55,9 @@ module PodcastIndex
         from_response_collection(response)
       end
 
-      def find_all_music_by_term(medium:, term:, val: nil, aponly: nil, clean: nil, fulltext: nil)
-        response = Api::Search.music_by_term(term: term, val: val, aponly: aponly, clean: clean, fulltext: fulltext)
+      def find_all_music_by_term(medium:, term:, val: nil, aponly: nil, clean: nil, fulltext: nil, max: nil)
+        response = Api::Search.music_by_term(term: term, val: val, aponly: aponly, clean: clean, fulltext: fulltext,
+                                             max: max)
         from_response_collection(response)
       end
 
@@ -74,13 +77,13 @@ module PodcastIndex
         from_response_collection(response)
       end
 
-      def find_all_by_term(term:, val: nil, aponly: nil, clean: nil, fulltext: nil)
-        response = Api::Search.by_term(term: term, val: val, aponly: aponly, clean: clean, fulltext: fulltext)
+      def find_all_by_term(term:, val: nil, aponly: nil, clean: nil, fulltext: nil, max: nil)
+        response = Api::Search.by_term(term: term, val: val, aponly: aponly, clean: clean, fulltext: fulltext, max: max)
         from_response_collection(response)
       end
 
-      def find_all_by_title(title:, val: nil, clean: nil, fulltext: nil)
-        response = Api::Search.by_title(title: title, val: val, clean: clean, fulltext: fulltext)
+      def find_all_by_title(title:, val: nil, clean: nil, fulltext: nil, max: nil)
+        response = Api::Search.by_title(title: title, val: val, clean: clean, fulltext: fulltext, max: max)
         from_response_collection(response)
       end
 

data/lib/podcast_index/version.rb

@@ -1,3 +1,3 @@
 module PodcastIndex
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0".freeze
 end

data/lib/podcast_index.rb

@@ -20,6 +20,7 @@ module PodcastIndex
   config_accessor :api_key, :api_secret, :base_url
 
   class Error < StandardError; end
+  class PodcastNotFound < Error; end
 
   def self.configure
     self.base_url = "https://api.podcastindex.org/api/1.0".freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: podcast_index
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jason York
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2023-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport