wcc-media-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c9d5ecd3de06add389d54a003a565a53f7612f0
+  data.tar.gz: 46b835cc5764ec42b9a6015b7d76bff810dbd9f9
+SHA512:
+  metadata.gz: 274b82199adba84eae9bb1159f588c31abc97d2afdca7f2975414aaf4b9752cf6d7f0308a14f4aaee459fdae94ed9b61bd23c8299ae580ebfe79566e0ce73a0d
+  data.tar.gz: 8f8afe9e13f987edea256c6cb5fcb11d18051c4b62de7104b0172186e1213a74b9c159660ed56080d884491fe0e742fc909c24799c559c59205cb153ed86d5e9

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,12 @@
+inherit_from: ../.rubocop.yml
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Exclude:
+    - 'spec/**/*'

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wcc-media-client.gemspec
+gemspec

data/lib/rest_client.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative 'rest_client/response'
+
+class RestClient
+  attr_reader :api_url
+
+  def initialize(api_url:, headers: nil, **options)
+    # normalizes a URL to have a slash on the end
+    @api_url = api_url.gsub(/\/+$/, '') + '/'
+
+    @adapter = RestClient.load_adapter(options[:adapter])
+
+    @options = options
+    @query_defaults = {}
+    @headers = {
+      'Accept' => 'application/json',
+    }.merge(headers || {}).freeze
+    @response_class = options[:response_class] || DefaultResponse
+  end
+
+  # performs an HTTP GET request to the specified path within the configured
+  # space and environment.  Query parameters are merged with the defaults and
+  # appended to the request.
+  def get(path, query = {})
+    url = URI.join(@api_url, path)
+
+    @response_class.new(self,
+      { url: url, query: query },
+      get_http(url, query))
+  end
+
+  ADAPTERS = {
+    http: ['http', '> 1.0', '< 3.0'],
+    typhoeus: ['typhoeus', '~> 1.0'],
+  }.freeze
+
+  # This method is long due to the case statement,
+  # not really a better way to do it
+  def self.load_adapter(adapter)
+    case adapter
+    when nil
+      ADAPTERS.each do |a, spec|
+        begin
+          gem(*spec)
+          return load_adapter(a)
+        rescue Gem::LoadError
+          next
+        end
+      end
+      raise ArgumentError, 'Unable to load adapter!  Please install one of '\
+        "#{ADAPTERS.values.map(&:join).join(',')}"
+    when :http
+      require_relative 'rest_client/http_adapter'
+      HttpAdapter.new
+    when :typhoeus
+      require_relative 'rest_client/typhoeus_adapter'
+      TyphoeusAdapter.new
+    else
+      unless adapter.respond_to?(:call)
+        raise ArgumentError, "Adapter #{adapter} is not invokeable!  Please "\
+          "pass a proc or use one of #{ADAPTERS.keys}"
+      end
+      adapter
+    end
+  end
+
+  private
+
+  def get_http(url, query, headers = {}, proxy = {})
+    headers = @headers.merge(headers || {})
+
+    q = @query_defaults.dup
+    q = q.merge(query) if query
+
+    resp = @adapter.call(url, q, headers, proxy)
+
+    resp = get_http(resp.headers['location'], nil, headers, proxy) if [301, 302, 307].include?(resp.code) && !@options[:no_follow_redirects]
+    resp
+  end
+end

data/lib/rest_client/api_error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class RestClient
+  class ApiError < StandardError
+    attr_reader :response
+
+    def self.[](code)
+      case code
+      when 404
+        NotFoundError
+      else
+        ApiError
+      end
+    end
+
+    def initialize(response)
+      @response = response
+      super(response.error_message)
+    end
+  end
+
+  class NotFoundError < ApiError
+  end
+end

data/lib/rest_client/http_adapter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+gem 'http'
+require 'http'
+
+class HttpAdapter
+  def call(url, query, headers = {}, proxy = {})
+    if proxy[:host]
+      HTTP[headers].via(proxy[:host], proxy[:port], proxy[:username], proxy[:password])
+        .get(url, params: query)
+    else
+      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/response.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require_relative 'api_error'
+
+class RestClient
+  class AbstractResponse
+    extend ::Forwardable
+
+    attr_reader :raw_response
+    attr_reader :raw_body
+    attr_reader :client
+    attr_reader :request
+
+    def_delegators :raw_response, :code, :headers
+
+    def body
+      @body ||= JSON.parse(raw_body)
+    end
+    alias_method :to_json, :body
+
+    def initialize(client, request, raw_response)
+      @client = client
+      @request = request
+      @raw_response = raw_response
+      @raw_body = raw_response.body.to_s
+    end
+
+    def skip
+      throw new NotImplementedError, 'Please implement "skip" parsing in response class'
+    end
+
+    def count
+      throw new NotImplementedError, 'Please implement "count" parsing in response class'
+    end
+
+    def collection_response?
+      page_items.nil? ? false : true
+    end
+
+    def page_items
+      throw new NotImplementedError, 'Please implement "page_items" parsing in response class'
+    end
+
+    def error_message
+      parsed_message =
+        begin
+          body.dig('error', 'message') || body.dig('message')
+        rescue JSON::ParserError
+          nil
+        end
+      parsed_message || "#{code}: #{raw_response.body}"
+    end
+
+    def next_page?
+      return false unless collection_response?
+
+      page_items.length + skip < count
+    end
+
+    def next_page
+      return unless next_page?
+
+      @next_page ||= @client.get(
+        @request[:url],
+        (@request[:query] || {}).merge(next_page_query)
+      )
+      @next_page.assert_ok!
+    end
+
+    def assert_ok!
+      return self if code >= 200 && code < 300
+
+      raise ApiError[code], self
+    end
+
+    # This method has a bit of complexity that is better kept in one location
+    def each_page(&block)
+      raise ArgumentError, 'Not a collection response' unless collection_response?
+
+      ret =
+        Enumerator.new do |y|
+          y << self
+
+          if next_page?
+            next_page.each_page.each do |page|
+              y << page
+            end
+          end
+        end
+
+      if block_given?
+        ret.map(&block)
+      else
+        ret.lazy
+      end
+    end
+
+    def items
+      return unless collection_response?
+
+      each_page.flat_map(&:page_items)
+    end
+
+    def first
+      raise ArgumentError, 'Not a collection response' unless collection_response?
+
+      page_items.first
+    end
+
+    def next_page_query
+      return unless collection_response?
+
+      {
+        skip: page_items.length + skip,
+      }
+    end
+  end
+
+  class DefaultResponse < AbstractResponse
+    def skip
+      body['skip']
+    end
+
+    def count
+      body['total']
+    end
+
+    def page_items
+      body['items']
+    end
+  end
+end

data/lib/rest_client/typhoeus_adapter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+gem 'typhoeus'
+require 'typhoeus'
+
+class RestClient
+  class TyphoeusAdapter
+    def call(url, query, headers = {}, proxy = {})
+      raise NotImplementedError, 'Proxying Not Yet Implemented' if proxy[:host]
+
+      TyphoeusAdapter::Response.new(
+        Typhoeus.get(
+          url,
+          params: query,
+          headers: headers
+        )
+      )
+    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
+
+        def_delegators :raw, :body, :to_s, :code, :headers
+
+        def status
+          raw.code
+        end
+      end
+  end
+end

data/lib/wcc/media/client.rb

@@ -0,0 +1,143 @@
+require_relative '../../rest_client'
+require_relative 'message'
+require_relative 'series'
+require_relative 'speaker'
+require_relative 'tag'
+require_relative 'client/response'
+
+module WCC
+  module Media
+    class Client < RestClient
+      PARAMS = %w[
+        limit
+        offset
+        order_by
+        sort
+        target
+      ].freeze
+
+      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'])
+      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'])
+      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'])
+      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'])
+      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

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

@@ -0,0 +1,29 @@
+module WCC
+  module Media
+    class Client < RestClient
+      class Response < RestClient::AbstractResponse
+        def skip
+          body.dig('pagination', 'offset')
+        end
+
+        def count
+          body.dig('pagination', 'total')
+        end
+
+        def collection_response?
+          body.key?('pagination')
+        end
+
+        def page_items
+          body['messages'] || body['series'] || body['speakers'] || body['tags']
+        end
+
+        def next_page_query
+          {
+            offset: page_items.length + skip,
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative '../../../rest_client'
+
+module WCC
+  module Media
+    class Client < RestClient
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

data/lib/wcc/media/message.rb

@@ -0,0 +1,60 @@
+module WCC
+  module Media
+    Message =
+      Struct.new(:raw) do
+        def id
+          raw['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
+
+        def speakers
+          (raw['speakers'] || []).map { |val| Speaker.new(val) }
+        end
+
+        def tags
+          (raw['tags'] || []).map { |val| Tag.new(val) }
+        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
+
+        %w[
+          embeds
+          assets
+          images
+          external_urls
+          transcript
+        ].each do |att|
+          define_method att do
+            OpenStruct.new(raw[att]) if raw[att]
+          end
+        end
+
+        undef raw=
+      end
+  end
+end

data/lib/wcc/media/series.rb

@@ -0,0 +1,36 @@
+module WCC
+  module Media
+    Series =
+      Struct.new(:raw) do
+        def id
+          raw['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[
+          images
+        ].each do |att|
+          define_method att do
+            OpenStruct.new(raw[att]) if raw[att]
+          end
+        end
+
+        undef raw=
+      end
+  end
+end

data/lib/wcc/media/speaker.rb

@@ -0,0 +1,25 @@
+module WCC
+  module Media
+    Speaker =
+      Struct.new(:raw) do
+        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
+
+        undef raw=
+      end
+  end
+end

data/lib/wcc/media/tag.rb

@@ -0,0 +1,24 @@
+module WCC
+  module Media
+    Tag =
+      Struct.new(:raw) do
+        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
+
+        undef raw=
+      end
+  end
+end

data/rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_helper"
+
+Bundler::GemHelper.install_tasks

data/wcc-media-client.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wcc/media/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wcc-media-client'
+  spec.version       = WCC::Media::Client::VERSION
+  spec.authors       = ['Watermark Dev']
+  spec.email         = ['dev@watermark.org']
+
+  spec.summary       = File.readlines(File.expand_path('README.md', __dir__)).join
+  spec.description   = 'REST Client for accessing the WCC Media library'
+  spec.homepage      = 'https://github.com/watermarkchurch/media/wcc-media-client'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.files         =
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+
+  spec.require_paths = ['lib']
+
+  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 '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

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: wcc-media-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Watermark Dev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httplog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- lib/rest_client.rb
+- lib/rest_client/api_error.rb
+- lib/rest_client/http_adapter.rb
+- lib/rest_client/response.rb
+- lib/rest_client/typhoeus_adapter.rb
+- lib/wcc/media/client.rb
+- lib/wcc/media/client/response.rb
+- lib/wcc/media/client/version.rb
+- lib/wcc/media/message.rb
+- lib/wcc/media/series.rb
+- lib/wcc/media/speaker.rb
+- lib/wcc/media/tag.rb
+- rakefile
+- wcc-media-client.gemspec
+homepage: https://github.com/watermarkchurch/media/wcc-media-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []