radio5 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34a7a071486c1b8ca66fd02b03fe53c05e8c4ac70b77a340e70f4e0539d2e3fd
-  data.tar.gz: c73e668fda26b54cb15a8d118b27219891e24cccd2880e6658fab3d63e2c00d3
+  metadata.gz: 6d9654787f0ddb8dbd5ced0d5022022e054730d9d276503071a11badabb0221c
+  data.tar.gz: ae010d8541628845e73dc4e290f93673645c42d05e3d01bc09f78766439ffd3f
 SHA512:
-  metadata.gz: a3f2a44eac15f31ffb700eadef35327c1990dcf90e5007fce6561b7474748cda2d99227385bf516800f63ca2e84be55e128ff2e959797f3739edcf732697c541
-  data.tar.gz: 1bd13fbcb3b333acb179404624ae79ea1d159d290cc6e423dc04f77aa9d3e33a33226750acb1a7aade1f4ae2b95b87f4725eb411bc0677b7de28e9d0ae6a510b
+  metadata.gz: 90c665ae324e9b82002d6c5f0c263dcd3cba50fa2f3c5588284c411d5c2d68f7b8d8eb5a53d206cb305785843506b6495f82167d73b32106ab071f851032e4cd
+  data.tar.gz: b9d13b3d27b5aff1832368be31673f7af1fa17376e27d1472efc308facba25d6c90ab4d7b21b21d7ad6e99ab54b915cec0f2f70dca1ca231029879ff08184f33

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.2.2
+----------
+
+- Refactored constants and validations
+- Refactored `Countries.countries_for_decade` method
+
 0.2.1
 ----------
 

data/README.md

@@ -327,6 +327,10 @@ client.user_followings("5d3306de06fb03d8871fd138", size: 1, page: 5)
 # => [{...}]
 ```
 
+## Examples
+
+You can find examples of usage [here](https://github.com/ocvit/radio5/blob/main/examples/).
+
 ## Auth?
 
 There is just a couple of features that require login (free or premium account):

data/lib/radio5/api.rb

@@ -52,7 +52,6 @@ module Radio5
       end
     end
 
-    # rubocop:disable Layout/HashAlignment
     def create_http
       Http.new(
         host:          HOST,
@@ -65,6 +64,5 @@ module Radio5
         debug_output:  client.debug_output
       )
     end
-    # rubocop:enable Layout/HashAlignment
   end
 end

data/lib/radio5/client/countries.rb

@@ -3,6 +3,8 @@
 module Radio5
   class Client
     module Countries
+      include Constants
+
       def countries
         _, json = api.get("/language/countries/en.json")
 
@@ -18,25 +20,11 @@ module Radio5
       def countries_for_decade(decade, group_by: :country)
         validate_decade!(decade)
 
-        # optimization to avoid doing this inside `case` to save HTTP request
-        unless [:mood, :country].include?(group_by)
-          raise ArgumentError, "invalid `group_by` value: #{group_by.inspect}"
-        end
-
-        _, json = api.get("/country/mood", query_params: {decade: decade})
-
-        grouped_by_mood = json.transform_keys do |mood_upcased|
-          mood = mood_upcased.downcase
-
-          validate_mood!(mood)
-
-          mood
-        end
-
         case group_by
         when :mood
-          grouped_by_mood
+          Fetcher.grouped_by_mood(api, decade)
         when :country
+          grouped_by_mood = Fetcher.grouped_by_mood(api, decade)
           grouped_by_country = Hash.new { |hash, country| hash[country] = [] }
 
           MOODS.each_with_object(grouped_by_country) do |mood, grouped_by_country|
@@ -44,6 +32,16 @@ module Radio5
               grouped_by_country[country] << mood
             end
           end
+        else
+          raise ArgumentError, "invalid `group_by` value: #{group_by.inspect}"
+        end
+      end
+
+      module Fetcher
+        def self.grouped_by_mood(api, decade)
+          _, json = api.get("/country/mood", query_params: {decade: decade})
+
+          json.transform_keys!(&:downcase)
         end
       end
     end

data/lib/radio5/client/islands.rb

@@ -14,7 +14,6 @@ module Radio5
       module Parser
         extend Utils
 
-        # rubocop:disable Layout/HashAlignment
         def self.island_info(island)
           rank_value = island[:sort]
           rank = rank_value if rank_value.is_a?(Integer)
@@ -50,7 +49,6 @@ module Radio5
             updated_by:      updated_by
           }
         end
-        # rubocop:enable Layout/HashAlignment
       end
     end
   end

data/lib/radio5/client/tracks.rb

@@ -3,6 +3,8 @@
 module Radio5
   class Client
     module Tracks
+      include Constants
+
       def track(track_id)
         validate_track_id!(track_id)
 
@@ -15,10 +17,8 @@ module Radio5
 
       # TODO: technically, API accepts an array of countries, but without premium
       # account only the first one is used during filtering.
-      # `country` should be used for now
-      # `countries` might be added in a future after implementation of auth
-
-      # rubocop:disable Layout/HashAlignment
+      #   `country` should be used for now
+      #   `countries` might be added in a future after implementation of auth
       def random_track(country: nil, decades: [], moods: MOODS)
         iso_codes = country ? [country] : []
 
@@ -39,9 +39,7 @@ module Radio5
       rescue Api::MatchingTrackNotFound
         nil
       end
-      # rubocop:enable Layout/HashAlignment
 
-      # rubocop:disable Layout/HashAlignment
       def island_track(island_id:, moods: MOODS)
         validate_island_id!(island_id)
         validate_moods!(moods)
@@ -58,12 +56,10 @@ module Radio5
       rescue Api::MatchingTrackNotFound
         nil
       end
-      # rubocop:enable Layout/HashAlignment
 
       module Parser
         extend Utils
 
-        # rubocop:disable Layout/HashAlignment
         def self.track_info(json)
           created_node = json[:created]
           created_at = created_node && parse_time_string(created_node.fetch(:date))
@@ -98,11 +94,10 @@ module Radio5
             created_by:  created_by
           }
         end
-        # rubocop:enable Layout/HashAlignment
 
         def self.track_audio(json, format)
           url = json.fetch(:links).fetch(format)
-          url.gsub!(/#t=\d*,\d+/, "")
+          url.gsub!(/#t=\d*,\d+/, "") # remove play time limit
 
           expires_at_unix = Integer(url[/(?<=expires=)\d+/])
           expires_at = parse_unix_timestamp(expires_at_unix)

data/lib/radio5/client/users.rb

@@ -3,6 +3,8 @@
 module Radio5
   class Client
     module Users
+      include Constants
+
       def user(id)
         validate_user_id!(id)
 
@@ -51,7 +53,7 @@ module Radio5
         _, json = api.get("/follow/list/follower/#{id}", query_params: {size: size, page: page})
 
         json.map do |user|
-          Parser.follow_user_info(user)
+          Parser.follower_user_info(user)
         end
       end
 
@@ -63,7 +65,7 @@ module Radio5
         _, json = api.get("/follow/list/following/#{id}", query_params: {size: size, page: page})
 
         json.map do |user|
-          Parser.follow_user_info(user)
+          Parser.following_user_info(user)
         end
       end
 
@@ -71,7 +73,6 @@ module Radio5
         raise NotImplementedError, "depends on auth"
       end
 
-      # rubocop:disable Layout/HashAlignment
       module Parser
         extend Utils
 
@@ -117,8 +118,7 @@ module Radio5
           }
         end
 
-        # TODO: strange name tbh, change later
-        def self.follow_user_info(user)
+        def self.follower_user_info(user)
           {
             id:         user.fetch(:_id),
             name:       normalize_string(user.fetch(:pseudonym)),
@@ -128,6 +128,9 @@ module Radio5
             created_at: parse_time_string(user.fetch(:created))
           }
         end
+        class << self
+          alias_method :following_user_info, :follower_user_info
+        end
 
         def self.normalize_year(time)
           if time.month == 12
@@ -137,7 +140,6 @@ module Radio5
           end
         end
       end
-      # rubocop:enable Layout/HashAlignment
     end
   end
 end

data/lib/radio5/client.rb

@@ -3,7 +3,7 @@
 module Radio5
   class Client
     include Utils
-    include Validator
+    include Validations
     include Users
     include Countries
     include Islands
@@ -32,11 +32,11 @@ module Radio5
     end
 
     def decades
-      DECADES
+      Constants::DECADES
     end
 
     def moods
-      MOODS
+      Constants::MOODS
     end
   end
 end

data/lib/radio5/constants.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Radio5
+  module Constants
+    DECADES = (1900..2020).step(10).to_a.freeze
+
+    MOODS_MAPPING = {
+      fast:  "FAST",
+      slow:  "SLOW",
+      weird: "WEIRD"
+    }.freeze
+
+    MOODS = MOODS_MAPPING.keys.freeze
+
+    USER_TRACK_STATUSES_MAPPING = {
+      posted:       "posted",
+      rejected:     "rejected",
+      on_air:       "onair",
+      confirmation: "confirmation",
+      duplicate:    "duplicate",
+      deleted:      "deleted",
+      broken:       "broken"
+    }.freeze
+
+    USER_TRACK_STATUSES = USER_TRACK_STATUSES_MAPPING.keys.freeze
+
+    IMAGE_SIZES = {
+      track: %i[thumb small medium large],
+      user:  %i[icon thumb small medium large]
+    }.freeze
+
+    ASSET_HOST = "https://asset.radiooooo.com"
+
+    MAX_PAGE_SIZE = 1_000_000_000
+  end
+end

data/lib/radio5/http.rb

@@ -30,7 +30,6 @@ module Radio5
 
     attr_reader :host, :port, :open_timeout, :read_timeout, :write_timeout, :proxy_url, :max_retries, :debug_output, :http_client
 
-    # rubocop:disable Layout/ExtraSpacing
     def initialize(
       host:,
       port:,
@@ -61,7 +60,6 @@ module Radio5
         c.set_debug_output(@debug_output)
       end
     end
-    # rubocop:enable Layout/ExtraSpacing
 
     def proxy_uri
       @proxy_uri ||= parse_proxy_uri

data/lib/radio5/utils.rb

@@ -5,14 +5,9 @@ require "time"
 
 module Radio5
   module Utils
-    module_function
-
-    ASSET_HOST = "https://asset.radiooooo.com"
+    include Constants
 
-    IMAGE_SIZES = {
-      track: %i[thumb small medium large],
-      user: %i[icon thumb small medium large]
-    }.freeze
+    module_function
 
     def parse_json(json_raw)
       JSON.parse(json_raw, symbolize_names: true)

data/lib/radio5/validations/matchers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Radio5
+  module Validations
+    module Matchers
+      module_function
+
+      def mongo_id?(object)
+        object.is_a?(String) && object.match?(Regexps::MONGO_ID)
+      end
+
+      def country_iso_code?(object)
+        object.is_a?(String) && object.match?(Regexps::COUNTRY_ISO_CODE)
+      end
+
+      def decade?(object)
+        object.is_a?(Integer) && Constants::DECADES.include?(object)
+      end
+
+      def mood?(object)
+        object.is_a?(Symbol) && Constants::MOODS.include?(object)
+      end
+
+      def user_track_status?(object)
+        object.is_a?(Symbol) && Constants::USER_TRACK_STATUSES.include?(object)
+      end
+
+      def positive_number?(object)
+        object.is_a?(Integer) && object.positive?
+      end
+    end
+  end
+end

data/lib/radio5/validations/regexps.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Radio5
+  module Validations
+    module Regexps
+      include Constants
+
+      MONGO_ID     = /\A[a-f\d]{24}\z/.freeze
+      UUID_GENERIC = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.freeze
+      UUID         = /\A#{UUID_GENERIC}\z/.freeze
+
+      COUNTRY_ISO_CODE_GENERIC = /([A-Z]{3}|KN1)/.freeze
+      COUNTRY_ISO_CODE         = /\A#{COUNTRY_ISO_CODE_GENERIC}\z/.freeze
+
+      # NOTE: everything below is used within RSpec custom matchers, they might be
+      # migrated to regular validations matchers in future, in case there will be
+      # a need to validate fields in response payloads on the fly
+
+      ASSET_URL = lambda do |sub_path, exts, size = nil|
+        asset_host = Regexp.escape(ASSET_HOST)
+        sub_path   = sub_path.is_a?(Regexp) ? sub_path : Regexp.escape(sub_path)
+        exts       = /(#{exts.join("|")})/
+        size       = /\/#{size}/ if size
+
+        /#{asset_host}#{sub_path}#{size}\/#{UUID_GENERIC}(_\d+)?\.#{exts}/.freeze
+      end.freeze
+
+      ISLAND_ICON_URL   = ASSET_URL.call("/island/icon", %w[png svg])
+      ISLAND_SPLASH_URL = ASSET_URL.call("/island/splash", %w[png svg])
+      ISLAND_MARKER_URL = ASSET_URL.call("/island/marker", %w[png svg])
+
+      TRACK_COVER_URLS = IMAGE_SIZES[:track].each_with_object({}) do |image_size, hash|
+        sub_path = %r(/cover/#{COUNTRY_ISO_CODE_GENERIC}/\d{4})
+        exts     = %w[jpg jpeg png gif]
+        regexp   = ASSET_URL.call(sub_path, exts, image_size)
+
+        hash[image_size] = regexp
+      end.freeze
+
+      USER_IMAGE_URLS = IMAGE_SIZES[:user].each_with_object({}) do |image_size, hash|
+        sub_path = %r{/user/\d+}
+        exts     = %w[jpg jpeg png gif]
+        regexp   = ASSET_URL.call(sub_path, exts, image_size)
+
+        hash[image_size] = regexp
+      end.freeze
+
+      AUDIO_URL = lambda do |exts|
+        exts = /(#{exts.join("|")})/
+
+        /.+\/#{UUID_GENERIC}\.#{exts}\?token=[^&]{22}&expires=\d{10}$/.freeze
+      end.freeze
+
+      MPEG_URL = AUDIO_URL.call(["mp3", "m4a"]).freeze
+      OGG_URL  = AUDIO_URL.call(["ogg"]).freeze
+    end
+  end
+end

data/lib/radio5/{validator.rb → validations.rb}

@@ -1,32 +1,11 @@
 # frozen_string_literal: true
 
 module Radio5
-  module Validator
+  module Validations
     module_function
 
-    def mongo_id?(object)
-      object.is_a?(String) && object.match?(Regexps::MONGO_ID)
-    end
-
-    def country_iso_code?(object)
-      object.is_a?(String) && object.match?(Regexps::COUNTRY_ISO_CODE)
-    end
-
-    def decade?(object)
-      object.is_a?(Integer) && DECADES.include?(object)
-    end
-
-    def mood?(object)
-      object.is_a?(Symbol) && MOODS_MAPPING.key?(object)
-    end
-
-    def user_track_status?(object)
-      object.is_a?(Symbol) && USER_TRACK_STATUSES_MAPPING.key?(object)
-    end
-
-    def positive_number?(object)
-      object.is_a?(Integer) && object.positive?
-    end
+    include Matchers
+    extend Matchers
 
     def validate!
       yield

data/lib/radio5/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Radio5
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/radio5.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require_relative "radio5/version"
+require_relative "radio5/constants"
 require_relative "radio5/utils"
 require_relative "radio5/http"
 require_relative "radio5/api"
-require_relative "radio5/regexps"
-require_relative "radio5/validator"
+require_relative "radio5/validations/regexps"
+require_relative "radio5/validations/matchers"
+require_relative "radio5/validations"
 require_relative "radio5/client/users"
 require_relative "radio5/client/countries"
 require_relative "radio5/client/islands"
@@ -13,27 +15,4 @@ require_relative "radio5/client/tracks"
 require_relative "radio5/client"
 
 module Radio5
-  DECADES = (1900..2020).step(10).to_a.freeze
-
-  MOODS_MAPPING = {
-    fast: "FAST",
-    slow: "SLOW",
-    weird: "WEIRD"
-  }.freeze
-
-  MOODS = MOODS_MAPPING.keys.freeze
-
-  USER_TRACK_STATUSES_MAPPING = {
-    posted: "posted",
-    rejected: "rejected",
-    on_air: "onair",
-    confirmation: "confirmation",
-    duplicate: "duplicate",
-    deleted: "deleted",
-    broken: "broken"
-  }.freeze
-
-  USER_TRACK_STATUSES = USER_TRACK_STATUSES_MAPPING.keys.freeze
-
-  MAX_PAGE_SIZE = 1_000_000_000
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: radio5
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Dmytro Horoshko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-02 00:00:00.000000000 Z
+date: 2024-02-10 00:00:00.000000000 Z
 dependencies: []
 description: Adapter for Radiooooo private API.
 email:
@@ -27,10 +27,12 @@ files:
 - lib/radio5/client/islands.rb
 - lib/radio5/client/tracks.rb
 - lib/radio5/client/users.rb
+- lib/radio5/constants.rb
 - lib/radio5/http.rb
-- lib/radio5/regexps.rb
 - lib/radio5/utils.rb
-- lib/radio5/validator.rb
+- lib/radio5/validations.rb
+- lib/radio5/validations/matchers.rb
+- lib/radio5/validations/regexps.rb
 - lib/radio5/version.rb
 homepage: https://github.com/ocvit/radio5
 licenses:

data/lib/radio5/regexps.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Radio5
-  module Regexps
-    include Utils
-
-    # rubocop:disable Layout/ExtraSpacing
-
-    MONGO_ID     = /^[a-f\d]{24}$/.freeze
-    UUID_GENERIC = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.freeze
-    UUID         = /^#{UUID_GENERIC}$/.freeze
-
-    COUNTRY_ISO_CODE_GENERIC = /([A-Z]{3}|KN1)/.freeze
-    COUNTRY_ISO_CODE         = /^#{COUNTRY_ISO_CODE_GENERIC}$/.freeze
-
-    ASSET_URL = lambda do |sub_path, exts, size = nil|
-      asset_host = Regexp.escape(Utils::ASSET_HOST)
-      sub_path   = sub_path.is_a?(Regexp) ? sub_path : Regexp.escape(sub_path)
-      exts       = /(#{exts.join("|")})/
-      size       = /\/#{size}/ if size
-
-      /#{asset_host}#{sub_path}#{size}\/#{UUID_GENERIC}(_\d+)?\.#{exts}/
-    end.freeze
-
-    ISLAND_ICON_URL   = ASSET_URL.call("/island/icon", ["png", "svg"]).freeze
-    ISLAND_SPLASH_URL = ASSET_URL.call("/island/splash", ["png", "svg"]).freeze
-    ISLAND_MARKER_URL = ASSET_URL.call("/island/marker", ["png", "svg"]).freeze
-
-    TRACK_COVER_URL = IMAGE_SIZES[:track].each_with_object({}) do |image_size, hash|
-      url = ASSET_URL.call(/\/cover\/#{COUNTRY_ISO_CODE_GENERIC}\/\d{4}/, ["jpg", "jpeg", "png", "gif"], image_size.to_s)
-      hash[image_size] = url
-    end.freeze
-
-    USER_IMAGE_URL = IMAGE_SIZES[:user].each_with_object({}) do |image_size, hash|
-      url = ASSET_URL.call(/\/user\/\d+/, ["jpg", "jpeg", "png", "gif"], image_size.to_s)
-      hash[image_size] = url
-    end.freeze
-
-    AUDIO_URL = lambda do |exts|
-      exts = /(#{exts.join("|")})/
-
-      /.+\/#{UUID_GENERIC}\.#{exts}\?token=[^&]{22}&expires=\d{10}$/
-    end.freeze
-
-    MPEG_URL = AUDIO_URL.call(["mp3", "m4a"]).freeze
-    OGG_URL  = AUDIO_URL.call(["ogg"]).freeze
-
-    # rubocop:enable Layout/ExtraSpacing
-  end
-end