wcc-media-client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c9d5ecd3de06add389d54a003a565a53f7612f0
-  data.tar.gz: 46b835cc5764ec42b9a6015b7d76bff810dbd9f9
+  metadata.gz: 1ab1f8952164ed4d304c0655216b90ec90a969ba
+  data.tar.gz: 064456e4cb0746adf4b3f824b9d6ef14cad2dbeb
 SHA512:
-  metadata.gz: 274b82199adba84eae9bb1159f588c31abc97d2afdca7f2975414aaf4b9752cf6d7f0308a14f4aaee459fdae94ed9b61bd23c8299ae580ebfe79566e0ce73a0d
-  data.tar.gz: 8f8afe9e13f987edea256c6cb5fcb11d18051c4b62de7104b0172186e1213a74b9c159660ed56080d884491fe0e742fc909c24799c559c59205cb153ed86d5e9
+  metadata.gz: 4e83253123e385d7c2d45f7dbb714aacebea52aa8466061349489b0cab6b1dd0b8faf3425575f019ba79bb9928d799b8c0eb3d0b88ae0e77fb36582a62850656
+  data.tar.gz: bef64997aec54a3d860686e0f322b1cfb0b5705cf4ec783835d790d12879c006d9afd76bcb591b3dfd56c7d7e3da99d78bbbbdef7d9094c0eaec456e104c8d91

data/lib/wcc/media/cacheable.rb

@@ -0,0 +1,18 @@
+module WCC
+  module Media
+    module Cacheable
+      def cache_key
+        return @cache_key if @cache_key
+
+        key =
+          (headers&.fetch('Etag', nil) if respond_to?(:headers))
+        key ||= WCC::Media::Cacheable.hash_cache_key(raw)
+        @cache_key = "#{self.class.name}/#{key}"
+      end
+
+      def self.hash_cache_key(hash)
+        Digest::SHA1.hexdigest(Marshal.dump(hash))
+      end
+    end
+  end
+end

data/lib/wcc/media/client/version.rb

@@ -3,7 +3,7 @@ require_relative '../../../rest_client'
 module WCC
   module Media
     class Client < RestClient
-      VERSION = '0.1.0'.freeze
+      VERSION = '0.1.1'.freeze
     end
   end
 end

data/lib/wcc/media/client.rb

@@ -46,7 +46,7 @@ module WCC
       def message(id)
         resp = get("messages/#{id}")
         resp.assert_ok!
-        WCC::Media::Message.new(resp.body['message'])
+        WCC::Media::Message.new(resp.body['message'], resp.headers.freeze)
       end
 
       SERIES_FILTERS = %w[
@@ -72,7 +72,7 @@ module WCC
       def series(id)
         resp = get("series/#{id}")
         resp.assert_ok!
-        WCC::Media::Series.new(resp.body['series'])
+        WCC::Media::Series.new(resp.body['series'], resp.headers.freeze)
       end
 
       SPEAKERS_FILTERS = %w[
@@ -92,7 +92,7 @@ module WCC
       def speaker(id)
         resp = get("speakers/#{id}")
         resp.assert_ok!
-        WCC::Media::Speaker.new(resp.body['speaker'])
+        WCC::Media::Speaker.new(resp.body['speaker'], resp.headers.freeze)
       end
 
       TAGS_FILTERS = %w[
@@ -110,7 +110,7 @@ module WCC
       def tag(id)
         resp = get("tags/#{id}")
         resp.assert_ok!
-        WCC::Media::Tag.new(resp.body['tag'])
+        WCC::Media::Tag.new(resp.body['tag'], resp.headers.freeze)
       end
 
       private

data/lib/wcc/media/message.rb

@@ -1,60 +1,68 @@
+require_relative 'cacheable'
+
 module WCC
   module Media
-    Message =
-      Struct.new(:raw) do
-        def id
-          raw['id']&.to_s
-        end
+    class Message
+      include WCC::Media::Cacheable
 
-        def legacy_id
-          raw['legacy_id']&.to_s
-        end
+      attr_reader :raw, :headers
 
-        %w[
-          date
-          title
-          description
-          series_position
-        ].each do |att|
-          define_method att do
-            raw[att]
-          end
-        end
+      def initialize(raw, headers = {})
+        @raw = raw
+        @headers = headers
+      end
 
-        def speakers
-          (raw['speakers'] || []).map { |val| Speaker.new(val) }
-        end
+      def id
+        raw['id']&.to_s
+      end
 
-        def tags
-          (raw['tags'] || []).map { |val| Tag.new(val) }
-        end
+      def legacy_id
+        raw['legacy_id']&.to_s
+      end
 
-        %w[
-          scripture_references
-          downloads
-        ].each do |att|
-          define_method att do
-            (raw[att] || []).map { |val| OpenStruct.new(val) }
-          end
+      %w[
+        date
+        title
+        description
+        series_position
+      ].each do |att|
+        define_method att do
+          raw[att]
         end
+      end
 
-        def series
-          Series.new(raw['series']) if raw['series']
-        end
+      def speakers
+        (raw['speakers'] || []).map { |val| Speaker.new(val) }
+      end
+
+      def tags
+        (raw['tags'] || []).map { |val| Tag.new(val) }
+      end
 
-        %w[
-          embeds
-          assets
-          images
-          external_urls
-          transcript
-        ].each do |att|
-          define_method att do
-            OpenStruct.new(raw[att]) if raw[att]
-          end
+      %w[
+        scripture_references
+        downloads
+      ].each do |att|
+        define_method att do
+          (raw[att] || []).map { |val| OpenStruct.new(val) }
         end
+      end
+
+      def series
+        Series.new(raw['series']) if raw['series']
+      end
 
-        undef raw=
+      %w[
+        embeds
+        assets
+        images
+        external_urls
+        transcript
+      ].each do |att|
+        define_method att do
+          OpenStruct.new(raw[att]) if raw[att]
+        end
       end
+    end
   end
 end

data/lib/wcc/media/series.rb

@@ -1,36 +1,42 @@
 module WCC
   module Media
-    Series =
-      Struct.new(:raw) do
-        def id
-          raw['id']&.to_s
-        end
+    class Series
+      include WCC::Media::Cacheable
 
-        def legacy_id
-          raw['legacy_id']&.to_s
-        end
+      attr_reader :raw, :headers
 
-        %w[
-          title
-          subtitle
-          summary
-          date_range
-          messages_count
-        ].each do |att|
-          define_method att do
-            raw[att]
-          end
-        end
+      def initialize(raw, headers = {})
+        @raw = raw
+        @headers = headers
+      end
+
+      def id
+        raw['id']&.to_s
+      end
+
+      def legacy_id
+        raw['legacy_id']&.to_s
+      end
 
-        %w[
-          images
-        ].each do |att|
-          define_method att do
-            OpenStruct.new(raw[att]) if raw[att]
-          end
+      %w[
+        title
+        subtitle
+        summary
+        date_range
+        messages_count
+      ].each do |att|
+        define_method att do
+          raw[att]
         end
+      end
 
-        undef raw=
+      %w[
+        images
+      ].each do |att|
+        define_method att do
+          OpenStruct.new(raw[att]) if raw[att]
+        end
       end
+    end
   end
 end

data/lib/wcc/media/speaker.rb

@@ -1,25 +1,31 @@
 module WCC
   module Media
-    Speaker =
-      Struct.new(:raw) do
-        def id
-          raw['id']&.to_s
-        end
+    class Speaker
+      include WCC::Media::Cacheable
 
-        def legacy_id
-          raw['legacy_id']&.to_s
-        end
+      attr_reader :raw, :headers
 
-        %w[
-          featured
-          name
-        ].each do |att|
-          define_method att do
-            raw[att]
-          end
-        end
+      def initialize(raw, headers = {})
+        @raw = raw
+        @headers = headers
+      end
 
-        undef raw=
+      def id
+        raw['id']&.to_s
+      end
+
+      def legacy_id
+        raw['legacy_id']&.to_s
+      end
+
+      %w[
+        featured
+        name
+      ].each do |att|
+        define_method att do
+          raw[att]
+        end
       end
+    end
   end
 end

data/lib/wcc/media/tag.rb

@@ -1,24 +1,30 @@
 module WCC
   module Media
-    Tag =
-      Struct.new(:raw) do
-        def id
-          raw['id']&.to_s
-        end
+    class Tag
+      include WCC::Media::Cacheable
 
-        def legacy_id
-          raw['legacy_id']&.to_s
-        end
+      attr_reader :raw, :headers
 
-        %w[
-          name
-        ].each do |att|
-          define_method att do
-            raw[att]
-          end
-        end
+      def initialize(raw, headers = {})
+        @raw = raw
+        @headers = headers
+      end
 
-        undef raw=
+      def id
+        raw['id']&.to_s
+      end
+
+      def legacy_id
+        raw['legacy_id']&.to_s
+      end
+
+      %w[
+        name
+      ].each do |att|
+        define_method att do
+          raw[att]
+        end
       end
+    end
   end
 end

data/wcc-media-client.gemspec

@@ -27,9 +27,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'http', '> 1.0', '< 3.0'
   spec.add_development_dependency 'httplog', '~> 1.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
   spec.add_development_dependency 'typhoeus', '~> 1.3'
   spec.add_development_dependency 'webmock', '~> 3.0'
-  spec.add_development_dependency 'rake', '~> 12.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-media-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Watermark Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2018-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,20 +128,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
 description: REST Client for accessing the WCC Media library
 email:
 - dev@watermark.org
@@ -144,6 +144,7 @@ files:
 - lib/rest_client/http_adapter.rb
 - lib/rest_client/response.rb
 - lib/rest_client/typhoeus_adapter.rb
+- lib/wcc/media/cacheable.rb
 - lib/wcc/media/client.rb
 - lib/wcc/media/client/response.rb
 - lib/wcc/media/client/version.rb