phoebe 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

data/lib/phoebe/resources/ref/hotspot/geo.rb

@@ -4,6 +4,8 @@ module Phoebe
   module Resources
     class Ref
       class Hotspot
+        # With the ref/hotspot end-points you can find the hotspots for a given country or
+        # region or nearby hotspots
         class Geo
           # Get the list of hotspots, within a radius of up to 50 kilometers, from a given
           # set of coordinates.
@@ -27,10 +29,11 @@ module Phoebe
           # @see Phoebe::Models::Ref::Hotspot::GeoRetrieveParams
           def retrieve(params)
             parsed, options = Phoebe::Ref::Hotspot::GeoRetrieveParams.dump_request(params)
+            query = Phoebe::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: "ref/hotspot/geo",
-              query: parsed,
+              query: query,
               model: Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Ref::Hotspot::GeoRetrieveResponseItem],
               options: options
             )

data/lib/phoebe/resources/ref/hotspot/info.rb

@@ -4,6 +4,8 @@ module Phoebe
   module Resources
     class Ref
       class Hotspot
+        # With the ref/hotspot end-points you can find the hotspots for a given country or
+        # region or nearby hotspots
         class Info
           # Get information on the location of a hotspot. #### Notes This API call only
           # works for hotspots. If you pass the location code for a private location or an

data/lib/phoebe/resources/ref/hotspot.rb

@@ -3,10 +3,16 @@
 module Phoebe
   module Resources
     class Ref
+      # With the ref/hotspot end-points you can find the hotspots for a given country or
+      # region or nearby hotspots
       class Hotspot
+        # With the ref/hotspot end-points you can find the hotspots for a given country or
+        # region or nearby hotspots
         # @return [Phoebe::Resources::Ref::Hotspot::Geo]
         attr_reader :geo
 
+        # With the ref/hotspot end-points you can find the hotspots for a given country or
+        # region or nearby hotspots
         # @return [Phoebe::Resources::Ref::Hotspot::Info]
         attr_reader :info
 
@@ -27,10 +33,11 @@ module Phoebe
         # @see Phoebe::Models::Ref::HotspotListParams
         def list(region_code, params = {})
           parsed, options = Phoebe::Ref::HotspotListParams.dump_request(params)
+          query = Phoebe::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["ref/hotspot/%1$s", region_code],
-            query: parsed,
+            query: query,
             model: Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Ref::HotspotListResponseItem],
             options: options
           )

data/lib/phoebe/resources/ref/region/adjacent.rb

@@ -4,6 +4,7 @@ module Phoebe
   module Resources
     class Ref
       class Region
+        # With the ref/geo end-point you can find a country's or region's neighbours.
         class Adjacent
           # Get the list of countries or regions that share a border with this one. ####
           # Notes Only subnational2 codes in the United States, New Zealand, or Mexico are

data/lib/phoebe/resources/ref/region/info.rb

@@ -4,6 +4,7 @@ module Phoebe
   module Resources
     class Ref
       class Region
+        # The ref/region end-points return information on regions.
         class Info
           # Get information on the name and geographical area covered by a region.
           #
@@ -36,10 +37,11 @@ module Phoebe
           # @see Phoebe::Models::Ref::Region::InfoRetrieveParams
           def retrieve(region_code, params = {})
             parsed, options = Phoebe::Ref::Region::InfoRetrieveParams.dump_request(params)
+            query = Phoebe::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["ref/region/info/%1$s", region_code],
-              query: parsed.transform_keys(region_name_format: "regionNameFormat"),
+              query: query.transform_keys(region_name_format: "regionNameFormat"),
               model: Phoebe::Models::Ref::Region::InfoRetrieveResponse,
               options: options
             )

data/lib/phoebe/resources/ref/region/list.rb

@@ -4,6 +4,7 @@ module Phoebe
   module Resources
     class Ref
       class Region
+        # The ref/region end-points return information on regions.
         class List
           # Get the list of sub-regions for a given country or region. #### Notes Not all
           # combinations of region type and region code are valid. You can fetch all the
@@ -25,6 +26,7 @@ module Phoebe
           # @see Phoebe::Models::Ref::Region::ListListParams
           def list(parent_region_code, params)
             parsed, options = Phoebe::Ref::Region::ListListParams.dump_request(params)
+            query = Phoebe::Internal::Util.encode_query_params(parsed)
             region_type =
               parsed.delete(:region_type) do
                 raise ArgumentError.new("missing required path argument #{_1}")
@@ -32,7 +34,7 @@ module Phoebe
             @client.request(
               method: :get,
               path: ["ref/region/list/%1$s/%2$s", region_type, parent_region_code],
-              query: parsed,
+              query: query,
               model: Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Ref::Region::ListListResponseItem],
               options: options
             )

data/lib/phoebe/resources/ref/region.rb

@@ -4,12 +4,15 @@ module Phoebe
   module Resources
     class Ref
       class Region
+        # With the ref/geo end-point you can find a country's or region's neighbours.
         # @return [Phoebe::Resources::Ref::Region::Adjacent]
         attr_reader :adjacent
 
+        # The ref/region end-points return information on regions.
         # @return [Phoebe::Resources::Ref::Region::Info]
         attr_reader :info
 
+        # The ref/region end-points return information on regions.
         # @return [Phoebe::Resources::Ref::Region::List]
         attr_reader :list
 

data/lib/phoebe/resources/ref/taxonomy/ebird.rb

@@ -29,10 +29,11 @@ module Phoebe
           # @see Phoebe::Models::Ref::Taxonomy::EbirdRetrieveParams
           def retrieve(params = {})
             parsed, options = Phoebe::Ref::Taxonomy::EbirdRetrieveParams.dump_request(params)
+            query = Phoebe::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: "ref/taxonomy/ebird",
-              query: parsed,
+              query: query,
               model: Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Ref::Taxonomy::EbirdRetrieveResponseItem],
               options: options
             )

data/lib/phoebe/resources/ref/taxonomy/species_groups.rb

@@ -25,10 +25,11 @@ module Phoebe
           # @see Phoebe::Models::Ref::Taxonomy::SpeciesGroupListParams
           def list(species_grouping, params = {})
             parsed, options = Phoebe::Ref::Taxonomy::SpeciesGroupListParams.dump_request(params)
+            query = Phoebe::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["ref/sppgroup/%1$s", species_grouping],
-              query: parsed.transform_keys(group_name_locale: "groupNameLocale"),
+              query: query.transform_keys(group_name_locale: "groupNameLocale"),
               model: Phoebe::Internal::Type::ArrayOf[Phoebe::Models::Ref::Taxonomy::SpeciesGroupListResponseItem],
               options: options
             )

data/lib/phoebe/resources/ref.rb

@@ -6,6 +6,8 @@ module Phoebe
       # @return [Phoebe::Resources::Ref::Region]
       attr_reader :region
 
+      # With the ref/hotspot end-points you can find the hotspots for a given country or
+      # region or nearby hotspots
       # @return [Phoebe::Resources::Ref::Hotspot]
       attr_reader :hotspot
 

data/lib/phoebe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Phoebe
-  VERSION = "0.1.0.pre.alpha.1"
+  VERSION = "0.1.0.pre.alpha.2"
 end

data/rbi/phoebe/internal/util.rbi

@@ -148,12 +148,20 @@ module Phoebe
         end
       end
 
+      # https://www.rfc-editor.org/rfc/rfc3986.html#section-3.3
+      RFC_3986_NOT_PCHARS = T.let(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/, Regexp)
+
       class << self
         # @api private
         sig { params(uri: URI::Generic).returns(String) }
         def uri_origin(uri)
         end
 
+        # @api private
+        sig { params(path: T.any(String, Integer)).returns(String) }
+        def encode_path(path)
+        end
+
         # @api private
         sig { params(path: T.any(String, T::Array[String])).returns(String) }
         def interpolate_path(path)
@@ -296,11 +304,31 @@ module Phoebe
       end
 
       JSON_CONTENT =
-        T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+        T.let(%r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}, Regexp)
       JSONL_CONTENT =
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: Phoebe::Internal::AnyHash).returns(
+            Phoebe::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: Phoebe::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

data/rbi/phoebe/models/data/observations/geo/recent/specie_list_params.rbi

@@ -18,6 +18,9 @@ module Phoebe
                   )
                 end
 
+              sig { returns(String) }
+              attr_accessor :species_code
+
               sig { returns(Float) }
               attr_accessor :lat
 
@@ -68,6 +71,7 @@ module Phoebe
 
               sig do
                 params(
+                  species_code: String,
                   lat: Float,
                   lng: Float,
                   back: Integer,
@@ -80,6 +84,7 @@ module Phoebe
                 ).returns(T.attached_class)
               end
               def self.new(
+                species_code:,
                 lat:,
                 lng:,
                 # The number of days back to fetch observations.
@@ -101,6 +106,7 @@ module Phoebe
               sig do
                 override.returns(
                   {
+                    species_code: String,
                     lat: Float,
                     lng: Float,
                     back: Integer,

data/rbi/phoebe/models/data/observations/nearest/geo_specie_list_params.rbi

@@ -17,6 +17,9 @@ module Phoebe
                 )
               end
 
+            sig { returns(String) }
+            attr_accessor :species_code
+
             sig { returns(Float) }
             attr_accessor :lat
 
@@ -67,6 +70,7 @@ module Phoebe
 
             sig do
               params(
+                species_code: String,
                 lat: Float,
                 lng: Float,
                 back: Integer,
@@ -79,6 +83,7 @@ module Phoebe
               ).returns(T.attached_class)
             end
             def self.new(
+              species_code:,
               lat:,
               lng:,
               # The number of days back to fetch observations.
@@ -100,6 +105,7 @@ module Phoebe
             sig do
               override.returns(
                 {
+                  species_code: String,
                   lat: Float,
                   lng: Float,
                   back: Integer,

data/rbi/phoebe/models/data/observations/recent/historic_list_params.rbi

@@ -26,6 +26,9 @@ module Phoebe
             sig { returns(Integer) }
             attr_accessor :m
 
+            sig { returns(Integer) }
+            attr_accessor :d
+
             # Only fetch observations from these taxonomic categories
             sig do
               returns(
@@ -120,6 +123,7 @@ module Phoebe
                 region_code: String,
                 y_: Integer,
                 m: Integer,
+                d: Integer,
                 cat:
                   Phoebe::Data::Observations::Recent::HistoricListParams::Cat::OrSymbol,
                 detail:
@@ -138,6 +142,7 @@ module Phoebe
               region_code:,
               y_:,
               m:,
+              d:,
               # Only fetch observations from these taxonomic categories
               cat: nil,
               # Include a subset (simple), or all (full), of the fields available.
@@ -164,6 +169,7 @@ module Phoebe
                   region_code: String,
                   y_: Integer,
                   m: Integer,
+                  d: Integer,
                   cat:
                     Phoebe::Data::Observations::Recent::HistoricListParams::Cat::OrSymbol,
                   detail:

data/rbi/phoebe/models/data/observations/recent/notable_list_params.rbi

@@ -17,6 +17,9 @@ module Phoebe
                 )
               end
 
+            sig { returns(String) }
+            attr_accessor :region_code
+
             # The number of days back to fetch observations.
             sig { returns(T.nilable(Integer)) }
             attr_reader :back
@@ -72,6 +75,7 @@ module Phoebe
 
             sig do
               params(
+                region_code: String,
                 back: Integer,
                 detail:
                   Phoebe::Data::Observations::Recent::NotableListParams::Detail::OrSymbol,
@@ -83,6 +87,7 @@ module Phoebe
               ).returns(T.attached_class)
             end
             def self.new(
+              region_code:,
               # The number of days back to fetch observations.
               back: nil,
               # Include a subset (simple), or all (full), of the fields available.
@@ -102,6 +107,7 @@ module Phoebe
             sig do
               override.returns(
                 {
+                  region_code: String,
                   back: Integer,
                   detail:
                     Phoebe::Data::Observations::Recent::NotableListParams::Detail::OrSymbol,

data/rbi/phoebe/models/data/observations/recent/specie_retrieve_params.rbi

@@ -20,6 +20,9 @@ module Phoebe
             sig { returns(String) }
             attr_accessor :region_code
 
+            sig { returns(String) }
+            attr_accessor :species_code
+
             # The number of days back to fetch observations.
             sig { returns(T.nilable(Integer)) }
             attr_reader :back
@@ -65,6 +68,7 @@ module Phoebe
             sig do
               params(
                 region_code: String,
+                species_code: String,
                 back: Integer,
                 hotspot: T::Boolean,
                 include_provisional: T::Boolean,
@@ -76,6 +80,7 @@ module Phoebe
             end
             def self.new(
               region_code:,
+              species_code:,
               # The number of days back to fetch observations.
               back: nil,
               # Only fetch observations from hotspots
@@ -96,6 +101,7 @@ module Phoebe
               override.returns(
                 {
                   region_code: String,
+                  species_code: String,
                   back: Integer,
                   hotspot: T::Boolean,
                   include_provisional: T::Boolean,

data/rbi/phoebe/models/data/observations/recent_list_params.rbi

@@ -16,6 +16,9 @@ module Phoebe
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :region_code
+
           # The number of days back to fetch observations.
           sig { returns(T.nilable(Integer)) }
           attr_reader :back
@@ -77,6 +80,7 @@ module Phoebe
 
           sig do
             params(
+              region_code: String,
               back: Integer,
               cat: Phoebe::Data::Observations::RecentListParams::Cat::OrSymbol,
               hotspot: T::Boolean,
@@ -88,6 +92,7 @@ module Phoebe
             ).returns(T.attached_class)
           end
           def self.new(
+            region_code:,
             # The number of days back to fetch observations.
             back: nil,
             # Only fetch observations from these taxonomic categories
@@ -109,6 +114,7 @@ module Phoebe
           sig do
             override.returns(
               {
+                region_code: String,
                 back: Integer,
                 cat:
                   Phoebe::Data::Observations::RecentListParams::Cat::OrSymbol,

data/rbi/phoebe/models/product/checklist_view_params.rbi

@@ -15,15 +15,23 @@ module Phoebe
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :sub_id
+
         sig do
-          params(request_options: Phoebe::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            sub_id: String,
+            request_options: Phoebe::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(sub_id:, request_options: {})
         end
 
-        sig { override.returns({ request_options: Phoebe::RequestOptions }) }
+        sig do
+          override.returns(
+            { sub_id: String, request_options: Phoebe::RequestOptions }
+          )
+        end
         def to_hash
         end
       end

data/rbi/phoebe/models/product/list_retrieve_params.rbi

@@ -15,6 +15,9 @@ module Phoebe
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :region_code
+
         # Only fetch this number of checklists.
         sig { returns(T.nilable(Integer)) }
         attr_reader :max_results
@@ -24,11 +27,13 @@ module Phoebe
 
         sig do
           params(
+            region_code: String,
             max_results: Integer,
             request_options: Phoebe::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          region_code:,
           # Only fetch this number of checklists.
           max_results: nil,
           request_options: {}
@@ -37,7 +42,11 @@ module Phoebe
 
         sig do
           override.returns(
-            { max_results: Integer, request_options: Phoebe::RequestOptions }
+            {
+              region_code: String,
+              max_results: Integer,
+              request_options: Phoebe::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/phoebe/models/product/lists/historical_retrieve_params.rbi

@@ -25,6 +25,9 @@ module Phoebe
           sig { returns(Integer) }
           attr_accessor :m
 
+          sig { returns(Integer) }
+          attr_accessor :d
+
           # Only fetch this number of checklists.
           sig { returns(T.nilable(Integer)) }
           attr_reader :max_results
@@ -55,6 +58,7 @@ module Phoebe
               region_code: String,
               y_: Integer,
               m: Integer,
+              d: Integer,
               max_results: Integer,
               sort_key:
                 Phoebe::Product::Lists::HistoricalRetrieveParams::SortKey::OrSymbol,
@@ -65,6 +69,7 @@ module Phoebe
             region_code:,
             y_:,
             m:,
+            d:,
             # Only fetch this number of checklists.
             max_results: nil,
             # Order the results by the date of the checklist or by the date it was submitted.
@@ -79,6 +84,7 @@ module Phoebe
                 region_code: String,
                 y_: Integer,
                 m: Integer,
+                d: Integer,
                 max_results: Integer,
                 sort_key:
                   Phoebe::Product::Lists::HistoricalRetrieveParams::SortKey::OrSymbol,

data/rbi/phoebe/models/product/species_list_list_params.rbi

@@ -15,15 +15,23 @@ module Phoebe
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :region_code
+
         sig do
-          params(request_options: Phoebe::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            region_code: String,
+            request_options: Phoebe::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(region_code:, request_options: {})
         end
 
-        sig { override.returns({ request_options: Phoebe::RequestOptions }) }
+        sig do
+          override.returns(
+            { region_code: String, request_options: Phoebe::RequestOptions }
+          )
+        end
         def to_hash
         end
       end

data/rbi/phoebe/models/product/stat_retrieve_params.rbi

@@ -24,15 +24,19 @@ module Phoebe
         sig { returns(Integer) }
         attr_accessor :m
 
+        sig { returns(Integer) }
+        attr_accessor :d
+
         sig do
           params(
             region_code: String,
             y_: Integer,
             m: Integer,
+            d: Integer,
             request_options: Phoebe::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(region_code:, y_:, m:, request_options: {})
+        def self.new(region_code:, y_:, m:, d:, request_options: {})
         end
 
         sig do
@@ -41,6 +45,7 @@ module Phoebe
               region_code: String,
               y_: Integer,
               m: Integer,
+              d: Integer,
               request_options: Phoebe::RequestOptions
             }
           )

data/rbi/phoebe/models/product/top100_retrieve_params.rbi

@@ -24,6 +24,9 @@ module Phoebe
         sig { returns(Integer) }
         attr_accessor :m
 
+        sig { returns(Integer) }
+        attr_accessor :d
+
         # Only fetch this number of contributors.
         sig { returns(T.nilable(Integer)) }
         attr_reader :max_results
@@ -51,6 +54,7 @@ module Phoebe
             region_code: String,
             y_: Integer,
             m: Integer,
+            d: Integer,
             max_results: Integer,
             ranked_by:
               Phoebe::Product::Top100RetrieveParams::RankedBy::OrSymbol,
@@ -61,6 +65,7 @@ module Phoebe
           region_code:,
           y_:,
           m:,
+          d:,
           # Only fetch this number of contributors.
           max_results: nil,
           # Order by number of complete checklists (cl) or by number of species seen (spp).
@@ -75,6 +80,7 @@ module Phoebe
               region_code: String,
               y_: Integer,
               m: Integer,
+              d: Integer,
               max_results: Integer,
               ranked_by:
                 Phoebe::Product::Top100RetrieveParams::RankedBy::OrSymbol,

data/rbi/phoebe/models/ref/hotspot/info_retrieve_params.rbi

@@ -16,15 +16,23 @@ module Phoebe
               )
             end
 
+          sig { returns(String) }
+          attr_accessor :loc_id
+
           sig do
-            params(request_options: Phoebe::RequestOptions::OrHash).returns(
-              T.attached_class
-            )
+            params(
+              loc_id: String,
+              request_options: Phoebe::RequestOptions::OrHash
+            ).returns(T.attached_class)
           end
-          def self.new(request_options: {})
+          def self.new(loc_id:, request_options: {})
           end
 
-          sig { override.returns({ request_options: Phoebe::RequestOptions }) }
+          sig do
+            override.returns(
+              { loc_id: String, request_options: Phoebe::RequestOptions }
+            )
+          end
           def to_hash
           end
         end