supercast 0.0.2

data/lib/supercast.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+# Supercast Ruby bindings
+require 'cgi'
+require 'faraday'
+require 'json'
+require 'logger'
+require 'openssl'
+require 'rbconfig'
+require 'securerandom'
+require 'set'
+require 'socket'
+require 'uri'
+
+# Version
+require_relative 'supercast/version'
+
+# API operations
+require_relative 'supercast/operations/create'
+require_relative 'supercast/operations/destroy'
+require_relative 'supercast/operations/list'
+require_relative 'supercast/operations/request'
+require_relative 'supercast/operations/save'
+
+# API resource support classes
+require_relative 'supercast/errors'
+require_relative 'supercast/client'
+require_relative 'supercast/data_types'
+require_relative 'supercast/util'
+require_relative 'supercast/data_object'
+require_relative 'supercast/response'
+require_relative 'supercast/data_list'
+require_relative 'supercast/resource'
+require_relative 'supercast/singleton'
+
+# Named API resources
+require_relative 'supercast/resources'
+
+module Supercast
+  DEFAULT_CA_BUNDLE_PATH ||= __dir__ + '/data/ca-certificates.crt'
+
+  @api_base = 'https://supercast.com/api'
+  @api_version = 'v1'
+
+  @log_level = nil
+  @logger = nil
+
+  @proxy = nil
+
+  @max_network_retries = 0
+  @max_network_retry_delay = 2
+  @initial_network_retry_delay = 0.5
+
+  @ca_bundle_path = DEFAULT_CA_BUNDLE_PATH
+  @ca_store = nil
+  @verify_ssl_certs = true
+
+  @open_timeout = 30
+  @read_timeout = 80
+
+  class << self
+    attr_accessor :api_key, :api_base, :verify_ssl_certs,
+                  :api_version, :open_timeout, :read_timeout, :proxy
+
+    attr_reader :max_network_retry_delay, :initial_network_retry_delay
+  end
+
+  # The location of a file containing a bundle of CA certificates. By default
+  # the library will use an included bundle that can successfully validate
+  # Supercast certificates.
+  def self.ca_bundle_path
+    @ca_bundle_path
+  end
+
+  def self.ca_bundle_path=(path)
+    @ca_bundle_path = path
+
+    # empty this field so a new store is initialized
+    @ca_store = nil
+  end
+
+  # A certificate store initialized from the the bundle in #ca_bundle_path and
+  # which is used to validate TLS on every request.
+  #
+  # This was added to the give the gem "pseudo thread safety" in that it seems
+  # when initiating many parallel requests marshaling the certificate store is
+  # the most likely point of failure. Any program attempting
+  # to leverage this pseudo safety should make a call to this method (i.e.
+  # `Supercast.ca_store`) in their initialization code because it marshals lazily
+  # and is itself not thread safe.
+  def self.ca_store
+    @ca_store ||= begin
+      store = OpenSSL::X509::Store.new
+      store.add_file(ca_bundle_path)
+      store
+    end
+  end
+
+  # Map to the same values as the standard library's logger
+  LEVEL_DEBUG ||= Logger::DEBUG
+  LEVEL_ERROR ||= Logger::ERROR
+  LEVEL_INFO ||= Logger::INFO
+
+  # When set prompts the library to log some extra information to $stdout and
+  # $stderr about what it's doing. For example, it'll produce information about
+  # requests, responses, and errors that are received. Valid log levels are
+  # `debug` and `info`, with `debug` being a little more verbose in places.
+  #
+  # Use of this configuration is only useful when `.logger` is _not_ set. When
+  # it is, the decision what levels to print is entirely deferred to the logger.
+  def self.log_level
+    @log_level
+  end
+
+  def self.log_level=(val)
+    raise ArgumentError, 'log_level should only be set to `nil`, `debug` or `info`' if !val.nil? && ![LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO].include?(val)
+
+    @log_level = val
+  end
+
+  # Sets a logger to which logging output will be sent. The logger should
+  # support the same interface as the `Logger` class that's part of Ruby's
+  # standard library (hint, anything in `Rails.logger` will likely be
+  # suitable).
+  #
+  # If `.logger` is set, the value of `.log_level` is ignored. The decision on
+  # what levels to print is entirely deferred to the logger.
+  def self.logger
+    @logger
+  end
+
+  def self.logger=(val)
+    @logger = val
+  end
+
+  def self.max_network_retries
+    @max_network_retries
+  end
+
+  def self.max_network_retries=(val)
+    @max_network_retries = val.to_i
+  end
+end
+
+Supercast.log_level = ENV['SUPERCAST_LOG'] unless ENV['SUPERCAST_LOG'].nil?

data/spec/lib/supercast/resource_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../../lib/supercast.rb', __dir__)
+
+RSpec.describe Supercast::Singleton do
+  describe 'self.resource_url' do
+    it 'should raise error with abstract class' do
+      expect { Supercast::Singleton.resource_url }.to raise_error(NotImplementedError)
+    end
+  end
+end

data/spec/lib/supercast/version_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../../lib/supercast.rb', __dir__)
+
+RSpec.describe Supercast::VERSION do
+  it 'should be defined' do
+    defined?(Supercast::VERSION).should be_truthy
+  end
+end

data/spec/lib/supercast_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../lib/supercast.rb', __dir__)
+
+RSpec.describe Supercast do
+  it 'should allow api_key to be configured' do
+    Supercast.api_key = '123abc'
+
+    Supercast.api_key.should eq('123abc')
+  end
+
+  it 'should allow ca_bundle_path to be configured' do
+    Supercast.ca_bundle_path = '/path/to/bundle'
+
+    Supercast.ca_bundle_path.should eq('/path/to/bundle')
+  end
+
+  it 'should allow log_level to be configured' do
+    Supercast.log_level = Supercast::LEVEL_DEBUG
+
+    Supercast.log_level.should eq(Supercast::LEVEL_DEBUG)
+  end
+
+  it 'should raise error on invalid log_level configuration' do
+    expect { Supercast.log_level = 'bad' }.to raise_error(ArgumentError)
+  end
+
+  it 'should allow logger to be configured' do
+    Supercast.logger = 1
+
+    Supercast.logger.should eq(1)
+  end
+
+  it 'should allow max_network_retries to be configured' do
+    Supercast.max_network_retries = 1
+
+    Supercast.max_network_retries.should eq(1)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+SimpleCov.start 'rails' do
+  add_filter 'app/admin'
+  add_filter 'app/_docs'
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+
+    expectations.syntax = %i[should expect]
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+
+    mocks.syntax = %i[should expect]
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: supercast
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jordan Ell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: Supercast ruby client
+email:
+- info@supercast.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/supercast-console.rb
+- lib/supercast.rb
+- lib/supercast/client.rb
+- lib/supercast/data_list.rb
+- lib/supercast/data_object.rb
+- lib/supercast/data_types.rb
+- lib/supercast/errors.rb
+- lib/supercast/operations/create.rb
+- lib/supercast/operations/destroy.rb
+- lib/supercast/operations/list.rb
+- lib/supercast/operations/request.rb
+- lib/supercast/operations/save.rb
+- lib/supercast/resource.rb
+- lib/supercast/resources.rb
+- lib/supercast/resources/channel.rb
+- lib/supercast/resources/creator.rb
+- lib/supercast/resources/episode.rb
+- lib/supercast/resources/invite.rb
+- lib/supercast/resources/role.rb
+- lib/supercast/resources/subscriber.rb
+- lib/supercast/resources/usage_alert.rb
+- lib/supercast/response.rb
+- lib/supercast/singleton.rb
+- lib/supercast/util.rb
+- lib/supercast/version.rb
+- spec/lib/supercast/resource_spec.rb
+- spec/lib/supercast/version_spec.rb
+- spec/lib/supercast_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/company-z/supercast-api-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A HTTP client for accessing Supercast services.
+test_files:
+- spec/spec_helper.rb
+- spec/lib/supercast_spec.rb
+- spec/lib/supercast/resource_spec.rb
+- spec/lib/supercast/version_spec.rb