podcast_index 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc3ddf4428c6108e1b2e5c3e5a9886283d34234cd85ccb8c6d927129d73d09fc
-  data.tar.gz: ebe518a53c0aeed362d57922464c13caae545b7535c7ea8622442286a55e2bd2
+  metadata.gz: 6401b33a024231d7afb4bea6585557e56c0d2d9d40d078a9f289c9e1d5df5382
+  data.tar.gz: 537b4f2c7df6efbf29595198b8a8edc014204173b900147f19504dcd328ad926
 SHA512:
-  metadata.gz: 83fe55e0065975fe9c6ee193247dacf1ba710cbf41660065ca81b1bdf7964f626f2540f7d2f63b6ef74b8937e6c5a3161e4d401777e23e0bee7bcdd74cfa4f55
-  data.tar.gz: 69a5aef31c4658c5934029522dd66f8e5e9b7d8c4040978302e03457b6ba181c6a70ddad786a12c8dab0d7d5de74fbb770d54daef08f197b4aada0a6e7818351
+  metadata.gz: 69eafb7f3827dc2ae609db437bef45c62010fbd3c4b580925cb4a26ab4b1ca579b6aac3d8c997469c0df772b9b99b6fb985cc0d143e3c736a11f2848f4076144
+  data.tar.gz: 47b8106313bc2d25004358b902a50be8f3536288ecaad330113f0f952e7eb84c20d0b9c943059494a11a3b78b6e977076fe9f33b963c579b7966d22413297bb5

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.4.0] - 2024-01-21
+
+* Add Categories to API (thanks @lbrito1)
+* Add Category domain model
+* Add stats API and domain model
+
+## [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))

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    podcast_index (0.2.1)
+    podcast_index (0.4.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

@@ -38,12 +38,16 @@ This client currently implements the following sections of the API:
 * [Episodes](https://podcastindex-org.github.io/docs-api/#tag--Episodes)
 * [Recent](https://podcastindex-org.github.io/docs-api/#tag--Recent)
 * [Value](https://podcastindex-org.github.io/docs-api/#tag--Value)
+* [Categories](https://podcastindex-org.github.io/docs-api/#tag--Categories)
+* [Stats](https://podcastindex-org.github.io/docs-api/#tag--Stats)
 
 These are exposed through the following domain models:
 * [Episode](lib/podcast_index/episode.rb)
 * [Podcast](lib/podcast_index/podcast.rb)
 * [Soundbite](lib/podcast_index/soundbite.rb)
 * [Value](lib/podcast_index/value.rb)
+* [Category](lib/podcast_index/category.rb)
+* [Stats](lib/podcast_index/stats.rb)
 
 The intent is to follow ActiveRecord conventions as reasonably possible.  Therefore, most of the requests are accessed through the model's `.find_by` and `.where` methods.
 
@@ -93,8 +97,6 @@ soundbite = PodcastIndex::Soundbite.where(recent: true)
 soundbite.first.episode_id # => 15082076307
 ```
 
-
-
 ### Supported Methods
 
 ```ruby
@@ -133,6 +135,13 @@ Soundbite.where(recent: true, max: nil)
 # Value
 Value.find_by(feed_id)
 Value.find_by(feed_url)
+
+# Category
+Category.all
+Category.find(category_id)
+
+# Stats
+Stats.current.feed_count_total # => 4316919
 ```
 
 The attributes of the models mirror the names in the API, but have been translated to "underscore" format to more closely follow Ruby conventions.  For example, the `lastUpdateTime` attribute for a `Podcast` is exposed as `last_update_time`.
@@ -149,6 +158,10 @@ rescue PodcastIndex::Error => e
 end
 ```
 
+## Performance
+
+Be aware that this client currently does not cache responses.  So for example, multiple calls to `Category.find()` or `Stats.current` will make multiple API requests.  This may change in the future.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/podcast_index/api/categories.rb

@@ -0,0 +1,14 @@
+module PodcastIndex
+  module Api
+    class Categories
+      extend Request
+
+      class << self
+        def list
+          response = get("/categories/list", pretty: false)
+          JSON.parse(response.body)
+        end
+      end
+    end
+  end
+end

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/api/stats.rb

@@ -0,0 +1,14 @@
+module PodcastIndex
+  module Api
+    class Stats
+      extend Request
+
+      class << self
+        def current
+          response = get("/stats/current", pretty: false)
+          JSON.parse(response.body)
+        end
+      end
+    end
+  end
+end

data/lib/podcast_index/category.rb

@@ -0,0 +1,29 @@
+require "ostruct"
+require "delegate"
+
+module PodcastIndex
+  class Category < SimpleDelegator
+    class << self
+      def find(id)
+        category = all.detect { |element| element.id == id }
+        raise PodcastIndex::CategoryNotFound if category.nil?
+
+        category
+      end
+
+      def all
+        response = Api::Categories.list
+        from_response_collection(response)
+      end
+
+    private
+
+      def from_response_collection(response, collection_key = "feeds")
+        response[collection_key].map do |item|
+          category = item.transform_keys(&:underscore)
+          new(JSON.parse(category.to_json, object_class: OpenStruct)) # rubocop:disable Style/OpenStructUse
+        end
+      end
+    end
+  end
+end

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

@@ -55,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
 
@@ -76,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/stats.rb

@@ -0,0 +1,20 @@
+require "ostruct"
+require "delegate"
+
+module PodcastIndex
+  class Stats < SimpleDelegator
+    class << self
+      def current
+        response = Api::Stats.current
+        from_response(response)
+      end
+
+    private
+
+      def from_response(response)
+        value = response["stats"].transform_keys(&:underscore)
+        new(JSON.parse(value.to_json, object_class: OpenStruct)) # rubocop:disable Style/OpenStructUse
+      end
+    end
+  end
+end

data/lib/podcast_index/version.rb

@@ -1,3 +1,3 @@
 module PodcastIndex
-  VERSION = "0.2.1".freeze
+  VERSION = "0.4.0".freeze
 end

data/lib/podcast_index.rb

@@ -4,14 +4,19 @@ require "active_support/core_ext/string/inflections"
 require "json"
 
 require_relative "podcast_index/api/request"
-require_relative "podcast_index/api/podcasts"
+
+require_relative "podcast_index/api/categories"
 require_relative "podcast_index/api/episodes"
-require_relative "podcast_index/api/search"
+require_relative "podcast_index/api/podcasts"
 require_relative "podcast_index/api/recent"
+require_relative "podcast_index/api/search"
+require_relative "podcast_index/api/stats"
 require_relative "podcast_index/api/value"
-require_relative "podcast_index/podcast"
+require_relative "podcast_index/category"
 require_relative "podcast_index/episode"
+require_relative "podcast_index/podcast"
 require_relative "podcast_index/soundbite"
+require_relative "podcast_index/stats"
 require_relative "podcast_index/value"
 
 module PodcastIndex
@@ -21,6 +26,7 @@ module PodcastIndex
 
   class Error < StandardError; end
   class PodcastNotFound < Error; end
+  class CategoryNotFound < 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.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jason York
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-06 00:00:00.000000000 Z
+date: 2024-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -171,15 +171,19 @@ files:
 - README.md
 - Rakefile
 - lib/podcast_index.rb
+- lib/podcast_index/api/categories.rb
 - lib/podcast_index/api/episodes.rb
 - lib/podcast_index/api/podcasts.rb
 - lib/podcast_index/api/recent.rb
 - lib/podcast_index/api/request.rb
 - lib/podcast_index/api/search.rb
+- lib/podcast_index/api/stats.rb
 - lib/podcast_index/api/value.rb
+- lib/podcast_index/category.rb
 - lib/podcast_index/episode.rb
 - lib/podcast_index/podcast.rb
 - lib/podcast_index/soundbite.rb
+- lib/podcast_index/stats.rb
 - lib/podcast_index/value.rb
 - lib/podcast_index/version.rb
 homepage: https://github.com/jasonyork/podcast-index