wcc-contentful 1.6.2 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 201a27cf2440f6857717728bedf9be194bda2ee14ae62f2eadbd8dca11d89d91
-  data.tar.gz: ab94d3e9a5bf2f369bc0cec01ede526541b896ac48e8d43bd19ceef5a0bc2994
+  metadata.gz: c6786c1c5b01c8b85965d264e6a18d7090078a0641c277150dad3e7b329404f3
+  data.tar.gz: f50c99943101b6939dd45cc0c47c2d1dd238efc316f0c90b2ae6dc166f0998ea
 SHA512:
-  metadata.gz: 9d0773e70c53a008b56ba96e9a352240db14902657c869449d47aefafc0d9889475947eec0c7e4f4b30d56444ea9763d5ab686045a6dd32bc67800ae62f0142a
-  data.tar.gz: c75c8423dc83f4e1ab695a5a5e0c18809235d0e1d4cbbaa3d960c9f8a3bb8380aab08d0324e87b45842c28a9eb514b9285cc49b418a5230026ccb3ccfe539509
+  metadata.gz: 85a4c6efdcc83997319363e10cbb54ce0e76b099f8ccee43d67aa07e70d7ddb36eb2c4bf2ca79d0da98a35805c1ea39e47d8c435dcbb7b9135c77f272dc52f5b
+  data.tar.gz: 90de4b1477610b3eaf73312da16864e92d42105a37334335f58ca3939e6b90f4c79aeb9973acd7a5d3d702e2d154934509158e5796674295376a630ae3333a76

data/lib/wcc/contentful/engine.rb

@@ -40,6 +40,10 @@ module WCC::Contentful
       end
     end
 
+    initializer 'wcc-contentful.deprecations' do |app|
+      app.deprecators[:wcc_contentful] = WCC::Contentful.deprecator if app.respond_to?(:deprecators)
+    end
+
     config.generators do |g|
       g.test_framework :rspec, fixture: false
     end

data/lib/wcc/contentful/link.rb

@@ -5,21 +5,30 @@ class WCC::Contentful::Link
 
   LINK_TYPES = {
     Asset: 'Asset',
-    Link: 'Entry'
+    Link: 'Entry',
+    Tag: 'Tag'
   }.freeze
 
   def initialize(model, link_type = nil)
-    @id = model.try(:id) || model
-    @link_type = link_type
-    @link_type ||= model.is_a?(WCC::Contentful::Model::Asset) ? :Asset : :Link
-    @raw =
-      {
-        'sys' => {
-          'type' => 'Link',
-          'linkType' => LINK_TYPES[@link_type] || link_type,
-          'id' => @id
+    if model.is_a?(Hash)
+      raise ArgumentError, 'Not a Link' unless model.dig('sys', 'type') == 'Link'
+
+      @raw = model
+      @id = model.dig('sys', 'id')
+      @link_type = model.dig('sys', 'linkType')
+    else
+      @id = model.try(:id) || model
+      @link_type = link_type
+      @link_type ||= model.is_a?(WCC::Contentful::Model::Asset) ? :Asset : :Link
+      @raw =
+        {
+          'sys' => {
+            'type' => 'Link',
+            'linkType' => LINK_TYPES[@link_type] || link_type,
+            'id' => @id
+          }
         }
-      }
+    end
   end
 
   alias_method :to_h, :raw

data/lib/wcc/contentful/metadata.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+WCC::Contentful::Metadata =
+  Struct.new(:raw) do
+    def tags
+      @tags ||=
+        Array(raw['tags'] || []).map do |tag|
+          WCC::Contentful::Link.new(tag) if tag.is_a?(Hash)
+        end
+    end
+  end

data/lib/wcc/contentful/model_api.rb

@@ -41,7 +41,7 @@ module WCC::Contentful::ModelAPI
     end
 
     def store(preview = nil)
-      ActiveSupport::Deprecation.warn('Use services.store instead')
+      WCC::Contentful.deprecator.warn('Use services.store instead')
 
       preview ? services.preview_store : services.store
     end

data/lib/wcc/contentful/model_builder.rb

@@ -3,6 +3,7 @@
 require 'ostruct'
 require_relative './link'
 require_relative './sys'
+require_relative './metadata'
 require_relative './rich_text'
 
 module WCC::Contentful
@@ -87,6 +88,10 @@ module WCC::Contentful
               OpenStruct.new(context).freeze
             )
 
+            @metadata = WCC::Contentful::Metadata.new(
+              raw['metadata'] || {}
+            )
+
             typedef.fields.each_value do |f|
               raw_value = raw.dig('fields', f.name)
 
@@ -120,6 +125,7 @@ module WCC::Contentful
           end
 
           attr_reader :sys
+          attr_reader :metadata
           attr_reader :raw
 
           delegate :id, to: :sys

data/lib/wcc/contentful/simple_client/cdn.rb

@@ -65,6 +65,33 @@ class WCC::Contentful::SimpleClient::Cdn < WCC::Contentful::SimpleClient
     resp.assert_ok!
   end
 
+  # https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/tags/tag-collection/get-all-tags/console
+  def tags(query = {})
+    resp =
+      _instrument 'tags', query: query do
+        get('tags', query)
+      end
+    resp.assert_ok!
+  end
+
+  # Retrieves a single tag by ID
+  #
+  # @param id [String] The ID of the tag to retrieve
+  # @param query [Hash] Optional query parameters
+  # @return [Response] Response containing the tag
+  # @raise [ArgumentError] If id is nil or empty
+  # @example
+  #   client.tag('sports')
+  def tag(id, query = {})
+    raise ArgumentError, 'id cannot be nil or empty' if id.nil? || id.empty?
+
+    resp =
+      _instrument 'tags', id: id, query: query do
+        get("tags/#{id}", query)
+      end
+    resp.assert_ok!
+  end
+
   # Accesses the Sync API to get a list of items that have changed since
   # the last sync.  Accepts a block that receives each changed item, and returns
   # the next sync token.
@@ -109,7 +136,7 @@ class WCC::Contentful::SimpleClient::Cdn < WCC::Contentful::SimpleClient
   private
 
   def sync_old(sync_token: nil, **query)
-    ActiveSupport::Deprecation.warn('Sync without a block is deprecated, please use new block syntax instead')
+    WCC::Contentful.deprecator.warn('Sync without a block is deprecated, please use new block syntax instead')
 
     sync_token =
       if sync_token

data/lib/wcc/contentful/simple_client/management.rb

@@ -66,6 +66,34 @@ class WCC::Contentful::SimpleClient::Management < WCC::Contentful::SimpleClient
     resp.assert_ok!
   end
 
+  def tags(query = {})
+    resp =
+      _instrument 'tags', query: query do
+        get("/spaces/#{space}/environments/#{environment}/tags", query)
+      end
+    resp.assert_ok!
+  end
+
+  def tag(key, query = {})
+    resp =
+      _instrument 'tags', tag: key, query: query do
+        get("/spaces/#{space}/environments/#{environment}/tags/#{key}", query)
+      end
+    resp.assert_ok!
+  end
+
+  def tag_create(tag_definition)
+    unless tag_id = tag_definition.dig('sys', 'id')
+      raise ArgumentError, "Missing tag ID in #{tag_definition}"
+    end
+
+    resp =
+      _instrument 'tag_create' do
+        put("/spaces/#{space}/environments/#{environment}/tags/#{tag_id}", tag_definition)
+      end
+    resp.assert_ok!
+  end
+
   # {
   #   "name": "My webhook",
   #   "url": "https://www.example.com/test",
@@ -109,16 +137,29 @@ class WCC::Contentful::SimpleClient::Management < WCC::Contentful::SimpleClient
       resp)
   end
 
+  def put(path, body)
+    url = URI.join(@api_url, path)
+
+    resp =
+      _instrument 'put_http', url: url do
+        post_http(url, body, {}, :put)
+      end
+
+    Response.new(self,
+      { url: url, body: body },
+      resp)
+  end
+
   private
 
-  def post_http(url, body, headers = {})
+  def post_http(url, body, headers = {}, method = :post)
     headers = {
       Authorization: "Bearer #{@access_token}",
       'Content-Type' => 'application/vnd.contentful.management.v1+json'
     }.merge(headers || {})
 
     body = body.to_json unless body.is_a? String
-    resp = @post_adapter.post(url, body, headers)
+    resp = @post_adapter.public_send(method, url, body, headers)
 
     if [301, 302, 307].include?(resp.status) && !@options[:no_follow_redirects]
       resp = get_http(resp.headers['location'], nil, headers)

data/lib/wcc/contentful/simple_client/typhoeus_adapter.rb

@@ -29,6 +29,18 @@ class WCC::Contentful::SimpleClient::TyphoeusAdapter
     )
   end
 
+  def put(url, body, headers = {}, proxy = {})
+    raise NotImplementedError, 'Proxying Not Yet Implemented' if proxy[:host]
+
+    Response.new(
+      Typhoeus.put(
+        url,
+        body: body.to_json,
+        headers: headers
+      )
+    )
+  end
+
   class Response < SimpleDelegator
     delegate :to_s, to: :body
 

data/lib/wcc/contentful/simple_client.rb

@@ -26,7 +26,7 @@ module WCC::Contentful
   class SimpleClient
     include WCC::Contentful::Instrumentation
 
-    attr_reader :api_url, :space
+    attr_reader :api_url, :space, :environment
 
     # Creates a new SimpleClient with the given configuration.
     #
@@ -54,9 +54,10 @@ module WCC::Contentful
       # https://www.contentful.com/developers/docs/references/content-preview-api/#/introduction/api-rate-limits
       @rate_limit_wait_timeout = @options[:rate_limit_wait_timeout] || 1.5
 
-      return unless options[:environment].present?
+      @environment = options[:environment]
+      return unless @environment.present?
 
-      @api_url = URI.join(@api_url, 'environments/', "#{options[:environment]}/")
+      @api_url = URI.join(@api_url, 'environments/', "#{@environment}/")
     end
 
     # performs an HTTP GET request to the specified path within the configured

data/lib/wcc/contentful/store/rspec_examples/basic_store.rb

@@ -224,6 +224,94 @@ RSpec.shared_examples 'basic store' do
       found2 = subject.find('1qLdW7i7g4Ycq6i4Cckg44')
       expect(found2.dig('fields', 'slug', 'en-US')).to eq('redirect-with-slug-and-url')
     end
+
+    it 'stores metadata including tags', focus: true do
+      entry_with_tags = JSON.parse <<~JSON
+        {
+          "metadata": {
+            "tags": [
+              {
+                "sys": {
+                  "type": "Link",
+                  "linkType": "Tag",
+                  "id": "ministry_careers-in-motion"
+                }
+              }
+            ],
+            "concepts": []
+          },
+          "sys": {
+            "space": {
+              "sys": {
+                "type": "Link",
+                "linkType": "Space",
+                "id": "hw5pse7y1ojx"
+              }
+            },
+            "id": "1h5ce0SYZq8cELhESiJFkA",
+            "type": "Entry",
+            "createdAt": "2020-02-06T20:25:19.188Z",
+            "updatedAt": "2024-11-21T19:02:37.381Z",
+            "environment": {
+              "sys": {
+                "id": "dev",
+                "type": "Link",
+                "linkType": "Environment"
+              }
+            },
+            "publishedVersion": 73,
+            "revision": 7,
+            "contentType": {
+              "sys": {
+                "type": "Link",
+                "linkType": "ContentType",
+                "id": "page"
+              }
+            }
+          },
+          "fields": {
+            "title": {
+              "en-US": "Finances and Career Care"
+            },
+            "slug": {
+              "en-US": "/ministries/financialcareers"
+            },
+            "sections": {
+              "en-US": [
+                {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Entry",
+                    "id": "4agnOGg0LQZrCbF4OeMEbj"
+                  }
+                },
+                {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Entry",
+                    "id": "614GfdpLaD5gjc0U3sITXY"
+                  }
+                },
+                {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Entry",
+                    "id": "xM5NWKiZSRUoUxXvoiYW4"
+                  }
+                }
+              ]
+            }
+          }
+        }
+      JSON
+
+      # act
+      subject.set('1h5ce0SYZq8cELhESiJFkA', entry_with_tags)
+      found = subject.find('1h5ce0SYZq8cELhESiJFkA')
+
+      # assert
+      expect(found.dig('metadata', 'tags', 0, 'sys', 'id')).to eq('ministry_careers-in-motion')
+    end
   end
 
   describe '#delete' do

data/lib/wcc/contentful/store/rspec_examples/include_param.rb

@@ -160,6 +160,119 @@ RSpec.shared_examples 'supports include param' do |feature_set|
         expect(link.dig('sys', 'type')).to eq('Entry')
         expect(link.dig('sys', 'id')).to eq('deep0')
       end
+
+      it 'preserves tags' do
+        entry_with_tags = JSON.parse <<~JSON
+          {
+            "metadata": {
+              "tags": [
+                {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Tag",
+                    "id": "ministry_careers-in-motion"
+                  }
+                }
+              ],
+              "concepts": []
+            },
+            "sys": {
+              "space": {
+                "sys": {
+                  "type": "Link",
+                  "linkType": "Space",
+                  "id": "hw5pse7y1ojx"
+                }
+              },
+              "id": "1h5ce0SYZq8cELhESiJFkA",
+              "type": "Entry",
+              "createdAt": "2020-02-06T20:25:19.188Z",
+              "updatedAt": "2024-11-21T19:02:37.381Z",
+              "environment": {
+                "sys": {
+                  "id": "dev",
+                  "type": "Link",
+                  "linkType": "Environment"
+                }
+              },
+              "publishedVersion": 73,
+              "revision": 7,
+              "contentType": {
+                "sys": {
+                  "type": "Link",
+                  "linkType": "ContentType",
+                  "id": "page"
+                }
+              }
+            },
+            "fields": {
+              "title": {
+                "en-US": "Finances and Career Care"
+              },
+              "slug": {
+                "en-US": "/ministries/financialcareers"
+              },
+              "sections": {
+                "en-US": [
+                  {
+                    "sys": {
+                      "type": "Link",
+                      "linkType": "Entry",
+                      "id": "4agnOGg0LQZrCbF4OeMEbj"
+                    }
+                  }
+                ]
+              }
+            }
+          }
+        JSON
+        linked_entry = JSON.parse(<<~JSON)
+          {
+            "metadata": {
+              "tags": [
+                {
+                  "sys": {
+                    "type": "Link",
+                    "linkType": "Tag",
+                    "id": "ministry_something-else"
+                  }
+                }
+              ],
+              "concepts": []
+            },
+            "sys": {
+              "id": "4agnOGg0LQZrCbF4OeMEbj",
+              "type": "Entry",
+              "contentType": {
+                "sys": {
+                  "type": "Link",
+                  "linkType": "ContentType",
+                  "id": "page"
+                }
+              }
+            },
+            "fields": {
+              "name": {
+                "en-US": "Linked Entry"
+              }
+            }
+          }
+        JSON
+
+        subject.set('1h5ce0SYZq8cELhESiJFkA', entry_with_tags)
+        subject.set('4agnOGg0LQZrCbF4OeMEbj', linked_entry)
+
+        # act
+        found = subject.find_by(content_type: 'page', filter: { slug: '/ministries/financialcareers' }, options: {
+          include: 1
+        })
+
+        # assert
+        expect(found.dig('metadata', 'tags', 0, 'sys', 'id')).to eq('ministry_careers-in-motion')
+        linked = found.dig('fields', 'sections', 'en-US', 0)
+        expect(linked.dig('fields', 'name', 'en-US')).to eq('Linked Entry')
+        expect(linked.dig('metadata', 'tags', 0, 'sys', 'id')).to eq('ministry_something-else')
+      end
     end
 
     describe '#find_all' do

data/lib/wcc/contentful/version.rb

@@ -2,6 +2,6 @@
 
 module WCC
   module Contentful
-    VERSION = '1.6.2'
+    VERSION = '1.7.1'
   end
 end

data/lib/wcc/contentful.rb

@@ -40,7 +40,7 @@ module WCC::Contentful
     attr_reader :configuration
 
     def types
-      ActiveSupport::Deprecation.warn('Use WCC::Contentful::Model.schema instead')
+      WCC::Contentful.deprecator.warn('Use WCC::Contentful::Model.schema instead')
       WCC::Contentful::Model.schema
     end
 
@@ -50,9 +50,20 @@ module WCC::Contentful
     end
 
     def logger
-      ActiveSupport::Deprecation.warn('Use WCC::Contentful::Services.instance.logger instead')
+      WCC::Contentful.deprecator.warn('Use WCC::Contentful::Services.instance.logger instead')
       WCC::Contentful::Services.instance.logger
     end
+
+    def deprecator
+      @deprecator ||=
+        begin
+          next_major_version = WCC::Contentful::VERSION.split('.').first.next
+          ActiveSupport::Deprecation.new(
+            "#{next_major_version}.0",
+            'wcc-contentful'
+          )
+        end
+    end
   end
 
   # Configures the WCC::Contentful gem to talk to a Contentful space.

data/wcc-contentful.gemspec

@@ -30,7 +30,6 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'byebug', '~> 11.0.1'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'dotenv', '~> 2.2'
   spec.add_development_dependency 'erb_lint', '~> 0.0.26'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: wcc-contentful
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.1
 platform: ruby
 authors:
 - Watermark Dev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 11.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 11.0.1
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -439,6 +425,7 @@ files:
 - lib/wcc/contentful/instrumentation.rb
 - lib/wcc/contentful/link.rb
 - lib/wcc/contentful/link_visitor.rb
+- lib/wcc/contentful/metadata.rb
 - lib/wcc/contentful/middleware.rb
 - lib/wcc/contentful/middleware/store.rb
 - lib/wcc/contentful/middleware/store/caching_middleware.rb
@@ -499,7 +486,7 @@ homepage: https://github.com/watermarkchurch/wcc-contentful/wcc-contentful
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://watermarkchurch.github.io/wcc-contentful/1.6/wcc-contentful
+  documentation_uri: https://watermarkchurch.github.io/wcc-contentful/1.7/wcc-contentful
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []