wcc-media-client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ab1f8952164ed4d304c0655216b90ec90a969ba
-  data.tar.gz: 064456e4cb0746adf4b3f824b9d6ef14cad2dbeb
+  metadata.gz: c6f7fff717257c4c3d0b5d052cc3a6fa470d4d7e
+  data.tar.gz: 48d5c6b4ea93e3d413bbe88e31f35d8a08437939
 SHA512:
-  metadata.gz: 4e83253123e385d7c2d45f7dbb714aacebea52aa8466061349489b0cab6b1dd0b8faf3425575f019ba79bb9928d799b8c0eb3d0b88ae0e77fb36582a62850656
-  data.tar.gz: bef64997aec54a3d860686e0f322b1cfb0b5705cf4ec783835d790d12879c006d9afd76bcb591b3dfd56c7d7e3da99d78bbbbdef7d9094c0eaec456e104c8d91
+  metadata.gz: b6daa3c34162ead40627b16a930d8336864a15527c871eb4f02113cfa0a2be6022d26d6ecd3fd53cd19b94c1e63c1b2ed0db0556aafdd2fbc656c2b00ede3a53
+  data.tar.gz: 2e6c537ea480120c8d72b87b54bf8c79012980df1516c48314cd9d4ee3d48a28cdc8415f4bb8bfe30cc5d0f2d2c6cb4661e4c754d2814b48d87dbb6f6cfb7804

data/lib/rest_client/http_adapter.rb

@@ -12,13 +12,4 @@ class HttpAdapter
       HTTP[headers].get(url, params: query)
     end
   end
-
-  def post(url, body, headers = {}, proxy = {})
-    if proxy[:host]
-      HTTP[headers].via(proxy[:host], proxy[:port], proxy[:username], proxy[:password])
-        .post(url, json: body)
-    else
-      HTTP[headers].post(url, json: body)
-    end
-  end
 end

data/lib/rest_client/typhoeus_adapter.rb

@@ -18,18 +18,6 @@ class RestClient
       )
     end
 
-    def post(url, body, headers = {}, proxy = {})
-      raise NotImplementedError, 'Proxying Not Yet Implemented' if proxy[:host]
-
-      TyphoeusAdapter::Response.new(
-        Typhoeus.post(
-          url,
-          body: body.to_json,
-          headers: headers
-        )
-      )
-    end
-
     Response =
       Struct.new(:raw) do
         extend Forwardable

data/lib/wcc/media/active_record_shim.rb

@@ -0,0 +1,77 @@
+module WCC::Media::ActiveRecordShim
+  def self.included(base)
+    base.public_send :include, InstanceMethods
+    base.extend ClassMethods
+  end
+
+  module InstanceMethods
+    def attributes
+      raw
+    end
+  end
+
+  module ClassMethods
+    def active_record_shim(&block)
+      builder = ShimBuilder.new
+      builder.instance_eval(&block)
+      builder.apply(self)
+      self
+    end
+
+    def find(id)
+      client.public_send(endpoint).find(id)
+    end
+
+    def find_all(**filters)
+      client.public_send(endpoint).list(filters)
+    end
+
+    def find_by(**filters)
+      raise ArgumentError, "You must provide at least one filter" if filters.empty?
+
+      find_all(filters).first
+    end
+
+    def model_name
+      name
+    end
+
+    def table_name
+      endpoint
+    end
+
+    def unscoped
+      yield
+    end
+
+    def find_in_batches(options, &block)
+      options = options ? options.dup : {}
+      batch_size = options.delete(:batch_size) || 1000
+      filter = {
+        limit: batch_size,
+        offset: options.delete(:start) || 0
+      }
+
+      find_all(filter).each_slice(batch_size, &block)
+    end
+  end
+
+  class ShimBuilder
+    def apply(klass)
+      filters = (@filters || []).freeze
+      endpoint = @endpoint || klass.name.split('::').last.downcase
+      name = @name || klass.name.split('::').last.downcase
+      klass.instance_eval do
+        define_singleton_method('filters') { filters }
+        define_singleton_method('endpoint') { endpoint }
+        define_singleton_method('name') { name }
+        define_singleton_method('client=') { |client| @client = client }
+        define_singleton_method('client') { @client || WCC::Media::Client.default }
+      end
+    end
+
+    [:filters, :endpoint, :name].each do |att|
+      class_eval("def #{att}(value); @#{att} = value; end", __FILE__, __LINE__)
+    end
+  end
+end

data/lib/wcc/media/base.rb

@@ -0,0 +1,18 @@
+require_relative 'cacheable'
+require_relative 'active_record_shim'
+
+module WCC
+  module Media
+    class Base
+      include WCC::Media::Cacheable
+      include WCC::Media::ActiveRecordShim
+
+      attr_reader :raw, :headers
+
+      def initialize(raw, headers = {})
+        @raw = raw
+        @headers = headers
+      end
+    end
+  end
+end

data/lib/wcc/media/client.rb

@@ -8,6 +8,10 @@ require_relative 'client/response'
 module WCC
   module Media
     class Client < RestClient
+      def self.default
+        @default ||= new
+      end
+
       PARAMS = %w[
         limit
         offset
@@ -16,128 +20,70 @@ module WCC
         target
       ].freeze
 
+      RESOURCES = {
+        'messages' => WCC::Media::Message,
+        'series' => WCC::Media::Series,
+        'speakers' => WCC::Media::Speaker,
+        'tags' => WCC::Media::Tag
+      }.freeze
+      attr_reader(*RESOURCES.keys)
+
+      attr_reader :options
+
       def initialize(**options)
         options = {
           api_url: 'https://media.watermark.org/api/v1/',
           response_class: Response
         }.merge!(options)
         super(**options)
-      end
-
-      MESSAGES_FILTERS = %w[
-        on_or_after_date
-        on_or_before_date
-        tag_id
-        speaker_id
-        scripture_book_id
-        series_id
-        title_like
-        legacy_id
-      ].freeze
-
-      def messages_list(**filters)
-        query = extract_params(filters)
-        query = query.merge!(apply_filters(filters, MESSAGES_FILTERS))
-        resp = get('messages', query)
-        resp.assert_ok!
-        resp.items.map { |m| WCC::Media::Message.new(m) }
-      end
-
-      def message(id)
-        resp = get("messages/#{id}")
-        resp.assert_ok!
-        WCC::Media::Message.new(resp.body['message'], resp.headers.freeze)
-      end
-
-      SERIES_FILTERS = %w[
-        begin_on_or_before_date
-        begin_on_or_after_date
-        end_on_or_before_date
-        end_on_or_after_date
-        tag_id
-        speaker_id
-        scripture_book_id
-        title_like
-        legacy_id
-      ]
-
-      def series_list(**filters)
-        query = extract_params(filters)
-        query = query.merge!(apply_filters(filters, SERIES_FILTERS))
-        resp = get('series', query)
-        resp.assert_ok!
-        resp.items.map { |s| WCC::Media::Series.new(s) }
-      end
-
-      def series(id)
-        resp = get("series/#{id}")
-        resp.assert_ok!
-        WCC::Media::Series.new(resp.body['series'], resp.headers.freeze)
-      end
 
-      SPEAKERS_FILTERS = %w[
-        featured
-        name_like
-        tag_id
-      ]
-
-      def speakers_list(**filters)
-        query = extract_params(filters)
-        query = query.merge!(apply_filters(filters, SPEAKERS_FILTERS))
-        resp = get('speakers', query)
-        resp.assert_ok!
-        resp.items.map { |s| WCC::Media::Speaker.new(s) }
-      end
-
-      def speaker(id)
-        resp = get("speakers/#{id}")
-        resp.assert_ok!
-        WCC::Media::Speaker.new(resp.body['speaker'], resp.headers.freeze)
-      end
-
-      TAGS_FILTERS = %w[
-        name_like
-      ]
-
-      def tags_list(**filters)
-        query = extract_params(filters)
-        query = query.merge!(apply_filters(filters, TAGS_FILTERS))
-        resp = get('tags', query)
-        resp.assert_ok!
-        resp.items.map { |s| WCC::Media::Tag.new(s) }
-      end
-
-      def tag(id)
-        resp = get("tags/#{id}")
-        resp.assert_ok!
-        WCC::Media::Tag.new(resp.body['tag'], resp.headers.freeze)
-      end
-
-      private
-
-      def extract_params(filters)
-        filters.each_with_object({}) do |(k, _v), h|
-          k_s = k.to_s
-          h[k_s] = filters.delete(k) if PARAMS.include?(k_s)
-        end
-      end
-
-      def apply_filters(filters, expected_filters)
-        defaults = default_filters(expected_filters) || {}
-        filters.each_with_object(defaults) do |(k, v), h|
-          k = k.to_s
-          raise ArgumentError, "Unknown filter '#{k}'" unless expected_filters.include?(k)
-
-          h["filter[#{k}]"] = v
+        RESOURCES.each do |(endpoint, model)|
+          instance_variable_set("@#{endpoint}", Resource.new(self, model, @options))
         end
       end
 
-      def default_filters(expected_filters)
-        @options[:default_filters]&.each_with_object({}) do |(k, v), h|
-          k = k.to_s
-          h["filter[#{k}]"] = v if expected_filters.include?(k)
+      Resource =
+        Struct.new(:client, :model, :options) do
+          def find(id)
+            resp = client.get("#{model.endpoint}/#{id}")
+            resp.assert_ok!
+            model.new(resp.body[model.name], resp.headers.freeze)
+          end
+
+          def list(**filters)
+            query = extract_params(filters)
+            query = query.merge!(apply_filters(filters, model.filters))
+            resp = client.get(model.endpoint, query)
+            resp.assert_ok!
+            resp.items.map { |s| model.new(s) }
+          end
+
+          private
+
+          def extract_params(filters)
+            filters.each_with_object({}) do |(k, _v), h|
+              k_s = k.to_s
+              h[k_s] = filters.delete(k) if PARAMS.include?(k_s)
+            end
+          end
+
+          def apply_filters(filters, expected_filters)
+            defaults = default_filters(expected_filters) || {}
+            filters.each_with_object(defaults) do |(k, v), h|
+              k = k.to_s
+              raise ArgumentError, "Unknown filter '#{k}'" unless expected_filters.include?(k)
+
+              h["filter[#{k}]"] = v
+            end
+          end
+
+          def default_filters(expected_filters)
+            options[:default_filters]&.each_with_object({}) do |(k, v), h|
+              k = k.to_s
+              h["filter[#{k}]"] = v if expected_filters.include?(k)
+            end
+          end
         end
-      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.1'.freeze
+      VERSION = '0.2.0'.freeze
     end
   end
 end

data/lib/wcc/media/message.rb

@@ -1,68 +1,69 @@
-require_relative 'cacheable'
+require_relative 'base'
 
-module WCC
-  module Media
-    class Message
-      include WCC::Media::Cacheable
-
-      attr_reader :raw, :headers
-
-      def initialize(raw, headers = {})
-        @raw = raw
-        @headers = headers
-      end
+class WCC::Media::Message < WCC::Media::Base
+  active_record_shim do
+    endpoint 'messages'
+    filters %w[
+      on_or_after_date
+      on_or_before_date
+      tag_id
+      speaker_id
+      scripture_book_id
+      series_id
+      title_like
+      legacy_id
+    ].freeze
+  end
 
-      def id
-        raw['id']&.to_s
-      end
+  def id
+    raw['id']&.to_s
+  end
 
-      def legacy_id
-        raw['legacy_id']&.to_s
-      end
+  def legacy_id
+    raw['legacy_id']&.to_s
+  end
 
-      %w[
-        date
-        title
-        description
-        series_position
-      ].each do |att|
-        define_method att do
-          raw[att]
-        end
-      end
+  %w[
+    date
+    title
+    description
+    series_position
+  ].each do |att|
+    define_method att do
+      raw[att]
+    end
+  end
 
-      def speakers
-        (raw['speakers'] || []).map { |val| Speaker.new(val) }
-      end
+  def speakers
+    (raw['speakers'] || []).map { |val| WCC::Media::Speaker.new(val) }
+  end
 
-      def tags
-        (raw['tags'] || []).map { |val| Tag.new(val) }
-      end
+  def tags
+    (raw['tags'] || []).map { |val| WCC::Media::Tag.new(val) }
+  end
 
-      %w[
-        scripture_references
-        downloads
-      ].each do |att|
-        define_method att do
-          (raw[att] || []).map { |val| OpenStruct.new(val) }
-        end
-      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
+  def series
+    WCC::Media::Series.new(raw['series']) if raw['series']
+  end
 
-      %w[
-        embeds
-        assets
-        images
-        external_urls
-        transcript
-      ].each do |att|
-        define_method att do
-          OpenStruct.new(raw[att]) if raw[att]
-        end
-      end
+  %w[
+    embeds
+    assets
+    images
+    external_urls
+    transcript
+  ].each do |att|
+    define_method att do
+      OpenStruct.new(raw[att]) if raw[att]
     end
   end
 end

data/lib/wcc/media/series.rb

@@ -1,42 +1,45 @@
-module WCC
-  module Media
-    class Series
-      include WCC::Media::Cacheable
+require_relative 'base'
 
-      attr_reader :raw, :headers
-
-      def initialize(raw, headers = {})
-        @raw = raw
-        @headers = headers
-      end
+class WCC::Media::Series < WCC::Media::Base
+  active_record_shim do
+    filters %w[
+      begin_on_or_before_date
+      begin_on_or_after_date
+      end_on_or_before_date
+      end_on_or_after_date
+      tag_id
+      speaker_id
+      scripture_book_id
+      title_like
+      legacy_id
+    ]
+  end
 
-      def id
-        raw['id']&.to_s
-      end
+  def id
+    raw['id']&.to_s
+  end
 
-      def legacy_id
-        raw['legacy_id']&.to_s
-      end
+  def legacy_id
+    raw['legacy_id']&.to_s
+  end
 
-      %w[
-        title
-        subtitle
-        summary
-        date_range
-        messages_count
-      ].each do |att|
-        define_method att do
-          raw[att]
-        end
-      end
+  %w[
+    title
+    subtitle
+    summary
+    date_range
+    messages_count
+  ].each do |att|
+    define_method att do
+      raw[att]
+    end
+  end
 
-      %w[
-        images
-      ].each do |att|
-        define_method att do
-          OpenStruct.new(raw[att]) if raw[att]
-        end
-      end
+  %w[
+    images
+  ].each do |att|
+    define_method att do
+      OpenStruct.new(raw[att]) if raw[att]
     end
   end
 end

data/lib/wcc/media/speaker.rb

@@ -1,31 +1,29 @@
-module WCC
-  module Media
-    class Speaker
-      include WCC::Media::Cacheable
+require_relative 'base'
 
-      attr_reader :raw, :headers
-
-      def initialize(raw, headers = {})
-        @raw = raw
-        @headers = headers
-      end
+class WCC::Media::Speaker < WCC::Media::Base
+  active_record_shim do
+    endpoint 'speakers'
+    filters %w[
+      featured
+      name_like
+      tag_id
+    ]
+  end
 
-      def id
-        raw['id']&.to_s
-      end
+  def id
+    raw['id']&.to_s
+  end
 
-      def legacy_id
-        raw['legacy_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
+  %w[
+    featured
+    name
+  ].each do |att|
+    define_method att do
+      raw[att]
     end
   end
 end

data/lib/wcc/media/tag.rb

@@ -1,30 +1,26 @@
-module WCC
-  module Media
-    class Tag
-      include WCC::Media::Cacheable
+require_relative 'base'
 
-      attr_reader :raw, :headers
-
-      def initialize(raw, headers = {})
-        @raw = raw
-        @headers = headers
-      end
+class WCC::Media::Tag < WCC::Media::Base
+  active_record_shim do
+    endpoint 'tags'
+    filters %w[
+      name_like
+    ]
+  end
 
-      def id
-        raw['id']&.to_s
-      end
+  def id
+    raw['id']&.to_s
+  end
 
-      def legacy_id
-        raw['legacy_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
+  %w[
+    name
+  ].each do |att|
+    define_method att do
+      raw[att]
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wcc-media-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Watermark Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2018-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -144,6 +144,8 @@ files:
 - lib/rest_client/http_adapter.rb
 - lib/rest_client/response.rb
 - lib/rest_client/typhoeus_adapter.rb
+- lib/wcc/media/active_record_shim.rb
+- lib/wcc/media/base.rb
 - lib/wcc/media/cacheable.rb
 - lib/wcc/media/client.rb
 - lib/wcc/media/client/response.rb