contentful 2.17.2 → 2.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a2120e270825f1bb0434d26f0b4eb42a445b7cb8df9fff01d7b1e71e1e76d91
-  data.tar.gz: 031e64513bfb83c80fcbc6bef5e426eadc1a24e11cf7ba0d69c04253a25e0447
+  metadata.gz: 3f73573b5e007f3d6ef23b5d347f1d524a0c88e7e1ad90f044a20290b71eb1df
+  data.tar.gz: d9ba166255a82387acbea7127f665c4aedd5181b36f5dab67a6ddc6286d87876
 SHA512:
-  metadata.gz: 94d85b10674c340396c1c8bb3605135645422d7f9ffda1ca25223850d84df20c5c0a598029a1cc6775ccd46c7b43477ba7d9139dbcfbdd3ea672cc4762bdfa1a
-  data.tar.gz: 4b671bee29520ebd6413e021a278278be4bba1b24813d6baff4b4053b5ed6ca42d1b76b8dccb7ce0fc3987065e63638e480d4448b3a89c147f0adc9380f8e3ae
+  metadata.gz: '0693f89bec3ad2bc4324b523fc6086260c26f0f48e20614df3005c8ae39d733915193ce7fe8f7698fe90c383610af030a8e18becd5ea4d8ae9dbb5dc0e6553d9'
+  data.tar.gz: aef73a49aad4da0757a2a2f8e013a46137e5bb6ebed392de2a3c916093b3a4ef96deabca8e33c1360c6eff9dd4b1edce58be4b18309cdd95934ba6ae0d5d28f2

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## 2.19.0
+* Added `http_instrumenter` configuration option to allow instrumenting HTTP requests. [#266](https://github.com/contentful/contentful.rb/pull/266)
+* Updated `http` gem version to `> 4`
+
+## 2.18.0
+* Added support for Taxonomy endpoints
+
 ## 2.17.2
 
 ### Fixed

data/README.md

@@ -56,6 +56,8 @@
     - [Configuration](#configuration)
     - [Reference documentation](#reference-documentation)
       - [Basic queries](#basic-queries)
+      - [Taxonomy Concepts](#taxonomy-concepts)
+      - [Taxonomy Concept Schemes](#taxonomy-concept-schemes)
       - [Filtering options](#filtering-options)
       - [Accessing fields and sys properties](#accessing-fields-and-sys-properties)
       - [Dynamic entries](#dynamic-entries)
@@ -367,6 +369,15 @@ client = Contentful::Client.new(
         the original log_level on the logger, for example when using Rails.logger.
       </td>
     </tr>
+    <tr>
+      <td><code>http_instrumenter</code></td>
+      <td><code>nil</code></td>
+      <td>
+        An HTTP instrumenter object that implements the <code>HTTP::Features::Instrumentation::Instrumenter</code> interface.
+        When provided, it will be used to instrument all HTTP requests made by the client.
+        This is useful for monitoring, logging, or tracking HTTP requests.
+      </td>
+    </tr>
   </tbody>
 </table>
 
@@ -381,6 +392,89 @@ nyancat = client.entry 'nyancat'
 entries = client.entries
 assets = client.assets
 nyancat_asset = client.asset 'nyancat'
+taxonomy_concept = client.taxonomy_concept '3DMf5gdax6J22AfcJ6fvsC'
+taxonomy_concept_scheme = client.taxonomy_concept_scheme '7CzXPy6XvYYd0D7SomitgI'
+```
+
+### Assets
+
+There is a helpful method to add image resize options for an asset image:
+
+```ruby
+client.asset('happycat').url
+# => "//images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/
+#     382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg"
+
+client.asset('happycat').url(width: 300, height: 200, format: 'jpg', quality: 100)
+# => "//images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/
+#     382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg?w=300&h=200&fm=jpg&q=100"
+```
+
+### Taxonomy Concepts
+
+You can retrieve taxonomy concepts using the taxonomy_concept method:
+
+```ruby
+# Get a specific taxonomy concept
+concept = client.taxonomy_concept('3DMf5gdax6J22AfcJ6fvsC')
+
+# Access basic properties
+concept.sys[:id] # => '3DMf5gdax6J22AfcJ6fvsC'
+concept.sys[:type] # => 'TaxonomyConcept'
+concept.uri # => nil or URI string
+
+# Access localized fields
+concept.pref_label # => 'sofa'
+concept.alt_labels # => []
+concept.definition # => ''
+concept.note # => ''
+
+# Access relationships
+concept.broader # => Array of broader concept links
+concept.related # => Array of related concept links
+concept.concept_schemes # => Array of concept scheme links
+```
+
+### Taxonomy Concept Schemes
+
+You can retrieve taxonomy concept schemes using the taxonomy_concept_scheme method:
+
+```ruby
+# Get a specific taxonomy concept scheme
+scheme = client.taxonomy_concept_scheme('7CzXPy6XvYYd0D7SomitgI')
+
+# Access basic properties
+scheme.sys[:id] # => '7CzXPy6XvYYd0D7SomitgI'
+scheme.sys[:type] # => 'TaxonomyConceptScheme'
+scheme.uri # => nil or URI string
+scheme.total_concepts # => 1
+
+# Access localized fields
+scheme.pref_label # => 'furniture'
+scheme.definition # => ''
+
+# Access relationships
+scheme.top_concepts # => Array of top concept links
+scheme.concepts # => Array of concept links
+
+# Get all taxonomy concept schemes
+schemes = client.taxonomy_concept_schemes
+
+# You can also use query parameters for filtering and pagination
+schemes = client.taxonomy_concept_schemes(limit: 10, order: 'sys.createdAt')
+schemes = client.taxonomy_concept_schemes(limit: 5, skip: 10)
+
+# The result is a Contentful::Array that you can iterate over
+schemes.each do |scheme|
+  puts "Scheme: #{scheme.pref_label} (ID: #{scheme.sys[:id]})"
+  puts "Total concepts: #{scheme.total_concepts}"
+end
+
+# Access pagination information
+if schemes.next_page_url
+  next_page = schemes.next_page_url
+  # You can use this URL to get the next page of results
+end
 ```
 
 #### Filtering options
@@ -424,13 +518,14 @@ entry.color # 'rainbow'
 entry.birthday # #<DateTime: 2011-04-04T22:00:00+00:00 ((2455656j,79200s,0n),+0s,2299161j)>
 ```
 
-#### Accessing tags
+#### Accessing tags and concepts
 
-Tags can be accessed via the `#_metadata` method.
+Tags and concepts can be accessed via the `#_metadata` method.
 
 ```ruby
 entry = client.entry 'nyancat'
 entry._metadata[:tags] # => [<Contentful::Link id='tagID'>]
+entry._metadata[:concepts] # => [<Contentful::Link id='conceptID'>]
 ```
 
 #### Dynamic entries
@@ -494,20 +589,6 @@ happycat.image
 happycat.image.resolve(client) # => #<Contentful::Asset: @fields={ ...
 ```
 
-### Assets
-
-There is a helpful method to add image resize options for an asset image:
-
-```ruby
-client.asset('happycat').url
-# => "//images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/
-#     382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg"
-
-client.asset('happycat').url(width: 300, height: 200, format: 'jpg', quality: 100)
-# => "//images.contentful.com/cfexampleapi/3MZPnjZTIskAIIkuuosCss/
-#     382a48dfa2cb16c47aa2c72f7b23bf09/happycatw.jpg?w=300&h=200&fm=jpg&q=100"
-```
-
 #### Resource options
 
 Resources, that have been requested directly (i.e. no child resources), can be fetched from the server again by calling `#reload`:

data/lib/contentful/array.rb

@@ -75,7 +75,8 @@ module Contentful
         'ContentType' => 'content_types',
         'Entry' => 'entries',
         'Asset' => 'assets',
-        'Locale' => 'locales'
+        'Locale' => 'locales',
+        'TaxonomyConcept' => 'taxonomy_concepts'
       }
 
       client.public_send(plurals[items.first.type], query.merge(limit: limit, skip: new_skip))

data/lib/contentful/base_resource.rb

@@ -98,7 +98,7 @@ module Contentful
     def hydrate_metadata
       result = {}
       raw.fetch('metadata', {}).each do |k, v|
-        v = v.map { |tag| build_link(tag) } if k == 'tags'
+        v = v.map { |item| build_link(item) } if %w[tags concepts].include?(k)
         result[Support.snakify(k, @configuration[:use_camel_case]).to_sym] = v
       end
       result

data/lib/contentful/client.rb

@@ -44,16 +44,18 @@ module Contentful
       application_name: nil,
       application_version: nil,
       integration_name: nil,
-      integration_version: nil
+      integration_version: nil,
+      http_instrumenter: nil
     }
 
     attr_reader :configuration, :logger, :proxy
 
     # Wraps the actual HTTP request via proxy
     # @private
-    def self.get_http(url, query, headers = {}, proxy = {}, timeout = {})
+    def self.get_http(url, query, headers = {}, proxy = {}, timeout = {}, instrumenter)
       http = HTTP[headers]
       http = http.timeout(timeout) if timeout.any?
+      http = http.use(instrumentation: { instrumenter: instrumenter }) if instrumenter
       if proxy[:host]
         http.via(proxy[:host], proxy[:port], proxy[:username], proxy[:password]).get(url, params: query)
       else
@@ -92,6 +94,10 @@ module Contentful
     # @option given_configuration [String] :application_version
     # @option given_configuration [String] :integration_name
     # @option given_configuration [String] :integration_version
+    # @option given_configuration [HTTP::Features::Instrumentation::Instrumenter, nil] :http_instrumenter
+    #   An HTTP instrumenter object that implements the instrumentation interface.
+    #   When provided, it will be used to instrument all HTTP requests made by the client.
+    #   This is useful for monitoring, logging, or tracking HTTP requests.
     def initialize(given_configuration = {})
       @configuration = default_configuration.merge(given_configuration)
       normalize_configuration!
@@ -215,6 +221,44 @@ module Contentful
       Request.new(self, environment_url('/locales'), query).get
     end
 
+    # Gets a specific taxonomy concept
+    #
+    # @param [String] id
+    # @param [Hash] query
+    #
+    # @return [Contentful::TaxonomyConcept]
+    def taxonomy_concept(id, query = {})
+      Request.new(self, environment_url('/taxonomy/concepts'), query, id).get
+    end
+
+    # Gets a collection of taxonomy concepts
+    #
+    # @param [Hash] query
+    #
+    # @return [Contentful::Array<Contentful::TaxonomyConcept>]
+    def taxonomy_concepts(query = {})
+      Request.new(self, environment_url('/taxonomy/concepts'), query).get
+    end
+
+    # Gets a specific taxonomy concept scheme
+    #
+    # @param [String] id
+    # @param [Hash] query
+    #
+    # @return [Contentful::TaxonomyConceptScheme]
+    def taxonomy_concept_scheme(id, query = {})
+      Request.new(self, environment_url('/taxonomy/concept-schemes'), query, id).get
+    end
+
+    # Gets a collection of taxonomy concept schemes
+    #
+    # @param [Hash] query
+    #
+    # @return [Contentful::Array<Contentful::TaxonomyConceptScheme>]
+    def taxonomy_concept_schemes(query = {})
+      Request.new(self, environment_url('/taxonomy/concept-schemes'), query).get
+    end
+
     # Returns the base url for all of the client's requests
     # @private
     def base_url
@@ -372,7 +416,8 @@ module Contentful
           request_query(request.query),
           request_headers,
           proxy_params,
-          timeout_params
+          timeout_params,
+          configuration[:http_instrumenter]
         ), request
       )
     end

data/lib/contentful/resource_builder.rb

@@ -9,6 +9,8 @@ require_relative 'deleted_entry'
 require_relative 'deleted_asset'
 require_relative 'locale'
 require_relative 'includes'
+require_relative 'taxonomy_concept'
+require_relative 'taxonomy_concept_scheme'
 
 module Contentful
   # Transforms a Contentful::Response into a Contentful::Resource or a Contentful::Error
@@ -25,13 +27,15 @@ module Contentful
       'Link' => Link,
       'DeletedEntry' => DeletedEntry,
       'DeletedAsset' => DeletedAsset,
-      'Locale' => Locale
+      'Locale' => Locale,
+      'TaxonomyConcept' => TaxonomyConcept,
+      'TaxonomyConceptScheme' => TaxonomyConceptScheme
     }.freeze
     # Default Entry Mapping
     # @see _ README for more information on Entry Mapping
     DEFAULT_ENTRY_MAPPING = {}.freeze
     # Buildable Resources
-    BUILDABLES = %w[Entry Asset ContentType Space DeletedEntry DeletedAsset Locale].freeze
+    BUILDABLES = %w[Entry Asset ContentType Space DeletedEntry DeletedAsset Locale TaxonomyConcept TaxonomyConceptScheme].freeze
 
     attr_reader :json, :default_locale, :endpoint, :depth, :localized, :resource_mapping, :entry_mapping, :resource, :query
 

data/lib/contentful/taxonomy_concept.rb

@@ -0,0 +1,95 @@
+require_relative 'base_resource'
+
+module Contentful
+  # Resource class for TaxonomyConcept.
+  # @see _ https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/taxonomy/concept
+  class TaxonomyConcept < BaseResource
+    attr_reader :uri, :notations, :broader, :related, :concept_schemes
+
+    def initialize(item, *)
+      super
+
+      @uri = item.fetch('uri', nil)
+      @notations = item.fetch('notations', [])
+      @broader = item.fetch('broader', [])
+      @related = item.fetch('related', [])
+      @concept_schemes = item.fetch('conceptSchemes', [])
+    end
+
+    # Returns true for resources that are taxonomy concepts
+    def taxonomy_concept?
+      true
+    end
+
+    # Returns false for resources that are not entries
+    def entry?
+      false
+    end
+
+    # Returns false for resources that are not assets
+    def asset?
+      false
+    end
+
+    # Access localized fields
+    def pref_label(locale = nil)
+      locale ||= default_locale
+      pref_label = raw.fetch('prefLabel', {})
+      pref_label.is_a?(Hash) ? pref_label.fetch(locale.to_s, nil) : pref_label
+    end
+
+    def alt_labels(locale = nil)
+      locale ||= default_locale
+      alt_labels = raw.fetch('altLabels', {})
+      alt_labels.is_a?(Hash) ? alt_labels.fetch(locale.to_s, []) : alt_labels
+    end
+
+    def hidden_labels(locale = nil)
+      locale ||= default_locale
+      hidden_labels = raw.fetch('hiddenLabels', {})
+      hidden_labels.is_a?(Hash) ? hidden_labels.fetch(locale.to_s, []) : hidden_labels
+    end
+
+    def note(locale = nil)
+      locale ||= default_locale
+      note = raw.fetch('note', {})
+      note.is_a?(Hash) ? note.fetch(locale.to_s, '') : note
+    end
+
+    def change_note(locale = nil)
+      locale ||= default_locale
+      change_note = raw.fetch('changeNote', {})
+      change_note.is_a?(Hash) ? change_note.fetch(locale.to_s, '') : change_note
+    end
+
+    def definition(locale = nil)
+      locale ||= default_locale
+      definition = raw.fetch('definition', {})
+      definition.is_a?(Hash) ? definition.fetch(locale.to_s, '') : definition
+    end
+
+    def editorial_note(locale = nil)
+      locale ||= default_locale
+      editorial_note = raw.fetch('editorialNote', {})
+      editorial_note.is_a?(Hash) ? editorial_note.fetch(locale.to_s, '') : editorial_note
+    end
+
+    def example(locale = nil)
+      locale ||= default_locale
+      example = raw.fetch('example', {})
+      example.is_a?(Hash) ? example.fetch(locale.to_s, '') : example
+    end
+
+    def history_note(locale = nil)
+      locale ||= default_locale
+      history_note = raw.fetch('historyNote', {})
+      history_note.is_a?(Hash) ? history_note.fetch(locale.to_s, '') : history_note
+    end
+
+    def scope_note(locale = nil)
+      locale ||= default_locale
+      scope_note = raw.fetch('scopeNote', {})
+      scope_note.is_a?(Hash) ? scope_note.fetch(locale.to_s, '') : scope_note
+    end
+  end
+end

data/lib/contentful/taxonomy_concept_scheme.rb

@@ -0,0 +1,51 @@
+require_relative 'base_resource'
+
+module Contentful
+  # Resource class for TaxonomyConceptScheme.
+  # @see _ https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/taxonomy/concept-scheme
+  class TaxonomyConceptScheme < BaseResource
+    attr_reader :uri, :top_concepts, :concepts, :total_concepts
+
+    def initialize(item, *)
+      super
+
+      @uri = item.fetch('uri', nil)
+      @top_concepts = item.fetch('topConcepts', [])
+      @concepts = item.fetch('concepts', [])
+      @total_concepts = item.fetch('totalConcepts', 0)
+    end
+
+    # Returns true for resources that are taxonomy concept schemes
+    def taxonomy_concept_scheme?
+      true
+    end
+
+    # Returns false for resources that are not taxonomy concepts
+    def taxonomy_concept?
+      false
+    end
+
+    # Returns false for resources that are not entries
+    def entry?
+      false
+    end
+
+    # Returns false for resources that are not assets
+    def asset?
+      false
+    end
+
+    # Access localized fields
+    def pref_label(locale = nil)
+      locale ||= default_locale
+      pref_label = raw.fetch('prefLabel', {})
+      pref_label.is_a?(Hash) ? pref_label.fetch(locale.to_s, nil) : pref_label
+    end
+
+    def definition(locale = nil)
+      locale ||= default_locale
+      definition = raw.fetch('definition', {})
+      definition.is_a?(Hash) ? definition.fetch(locale.to_s, '') : definition
+    end
+  end
+end

data/lib/contentful/version.rb

@@ -1,5 +1,5 @@
 # Contentful Namespace
 module Contentful
   # Gem Version
-  VERSION = '2.17.2'
+  VERSION = '2.19.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful
 version: !ruby/object:Gem::Version
-  version: 2.17.2
+  version: 2.19.0
 platform: ruby
 authors:
 - Contentful GmbH (Jan Lelis)
@@ -278,6 +278,8 @@ files:
 - lib/contentful/support.rb
 - lib/contentful/sync.rb
 - lib/contentful/sync_page.rb
+- lib/contentful/taxonomy_concept.rb
+- lib/contentful/taxonomy_concept_scheme.rb
 - lib/contentful/version.rb
 homepage: https://github.com/contentful/contentful.rb
 licenses: