prx_access 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 993d498f3a6140c1f29f964f5d77eca7c73361057bea37efb2adc485ca00a60a
+  data.tar.gz: 6be33628433e2090b0b7bed7a06098b6b4d968809d75aa825bedec3caac60eea
+SHA512:
+  metadata.gz: 8fae3fac0e2698b9eb9133b06c645ef40328af0045429d3e237c885044655594c58b14f642f73e3581f0d64854940f8c35eef2a183d51a242fb65f0c5fd88665
+  data.tar.gz: 4d1a4587263130aaa5b4f14f43c459ca9c4d8e176772ec24cd3cc7ce00a5fda804c7dc3951733b225d3a1ae47606237d2b9fd65fa21547ee7df517e0378eba91

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sam.vevang@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in prx_access.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Public Radio Exchange
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# PrxAccess
+
+Welcome to PRX Access. This gem allows programmatic to the PRX HAL apis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prx_access'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prx_access
+
+## Usage
+
+PRXAccess is meant to be used as a mixin for your classes. Here's a
+short example of how to fetch podcasts from feeder in Ruby:
+
+```
+Running via Spring preloader in process 35676
+Loading development environment (Rails 4.2.10)
+irb(main):001:0> include PRXAccess
+=> Object
+irb(main):002:0> feeder_api = api(root: feeder_root)
+=> #<PRXAccess::PRXHyperResource:0x3fce3bda28e0 @root="https://feeder.prx.org/api/v1" @href=nil @loaded=false @namespace="PRXAccess::PRXHyperResource" ...>
+irb(main):003:0> root_api = feeder_api.get
+=> #<PRXAccess::PRXHyperResource:0x3fce3bd1be08 @root="https://feeder.prx.org/api/v1" @href="/api/v1" @loaded=true @namespace="PRXAccess::PRXHyperResource" ...>
+irb(main):004:0> podcasts_api = root_api.podcasts.first
+=> #<PRXAccess::PRXHyperResource::Link:0x00007f9c779ee510 @resource=#<PRXAccess::PRXHyperResource:0x3fce3bd1be08 @root="https://feeder.prx.org/api/v1" @href="/api/v1" @loaded=true @namespace="PRXAccess::PRXHyperResource" ...>, @base_href="/api/v1/podcasts{?page,per,zoom}", @name=nil, @templated=true, @params={}, @default_method="get", @headers={}, @type=nil, @profile="http://meta.prx.org/model/collection/podcasts">
+irb(main):005:0> podcasts_api.get.body
+=> {"count"=>10, "total"=>122, "_embedded"=>{"prx:items"=>[  ... <snip json>
+```
+
+It's also possible to chain the calls:
+
+```ruby
+api(root: feeder_root)
+	.get
+	.podcasts.first
+	.get
+	.body
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake` to run the tests. You can also run `bin/console`
+for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will create
+a git tag for the version, push git commits and tags, and push the
+`.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/prx_access. This project is intended to be
+a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [Contributor Covenant](http://contributor-covenant.org)
+code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the PrxAccess project’s codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code
+of
+conduct](https://github.com/[USERNAME]/prx_access/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "prx_access"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/prx_access.rb

@@ -0,0 +1,5 @@
+require "prx_access/version"
+require "prx_access/prx_hyper_resource"
+
+module PRXAccess
+end

data/lib/prx_access/prx_hyper_resource.rb

@@ -0,0 +1,141 @@
+require 'hyperresource'
+require 'active_support/core_ext/hash'
+
+module PRXAccess
+
+  class PRXHyperResource < HyperResource
+    def incoming_body_filter(hash)
+      super(hash.deep_transform_keys { |key| key.to_s.underscore })
+    end
+
+    def outgoing_body_filter(hash)
+      super(hash.deep_transform_keys { |key| key.to_s.camelize(:lower) })
+    end
+
+    class Link < HyperResource::Link
+      attr_accessor :type, :profile
+
+      def initialize(resource, link_spec={})
+        super
+        self.type = link_spec['type']
+        self.profile = link_spec['profile']
+      end
+
+      def where(params)
+        super.tap do |res|
+          res.type = self.type
+          res.profile = self.profile
+        end
+      end
+
+      def headers(*args)
+        super.tap do |res|
+          if args.count > 0
+            res.type = self.type
+            res.profile = self.profile
+          end
+        end
+      end
+
+      def post_response(attrs=nil)
+        attrs ||= self.resource.attributes
+        attrs = (self.resource.default_attributes || {}).merge(attrs)
+
+        # adding this line to call outgoing_body_filter
+        attrs = resource.outgoing_body_filter(attrs)
+
+        response = faraday_connection.post do |req|
+          req.body = self.resource.adapter.serialize(attrs)
+        end
+        response
+      end
+
+      def put_response(attrs=nil)
+        attrs ||= self.resource.attributes
+        attrs = (self.resource.default_attributes || {}).merge(attrs)
+
+        # adding this line to call outgoing_body_filter
+        attrs = resource.outgoing_body_filter(attrs)
+
+        response = faraday_connection.put do |req|
+          req.body = self.resource.adapter.serialize(attrs)
+        end
+        response
+      end
+
+      def patch_response(attrs=nil)
+        attrs ||= self.resource.attributes.changed_attributes
+        attrs = (self.resource.default_attributes || {}).merge(attrs)
+
+        # adding this line to call outgoing_body_filter
+        attrs = resource.outgoing_body_filter(attrs)
+
+        response = faraday_connection.patch do |req|
+          req.body = self.resource.adapter.serialize(attrs)
+        end
+        response
+      end
+    end
+  end
+
+  def default_headers
+    {
+      'Content-Type' => 'application/json',
+      'Accept' =>  'application/json'
+    }
+  end
+
+  def api(options = {})
+    opts = { root: cms_root, headers: default_headers }.merge(options)
+    if !opts[:headers]['Authorization'] && account = opts.delete(:account)
+      token = get_account_token(account)
+      opts[:headers]['Authorization'] = "Bearer #{token}"
+    end
+
+    PRXHyperResource.new(opts)
+  end
+
+  def api_resource(body, root = cms_root)
+    href = body['_links']['self']['href']
+    resource = api(root: root)
+    link = PRXHyperResource::Link.new(resource, href: href)
+    PRXHyperResource.new_from(body: body, resource: resource, link: link)
+  end
+
+  def get_account_token(account)
+    id = ENV['PRX_CLIENT_ID']
+    se = ENV['PRX_SECRET']
+    oauth_options = { site: id_root, token_url: '/token' }
+    client = OAuth2::Client.new(id, se, oauth_options) do |faraday|
+      faraday.request  :url_encoded
+      faraday.adapter  :excon
+    end
+    client.client_credentials.get_token(account: account).token
+  end
+
+  def id_root
+    root_uri ENV['ID_HOST']
+  end
+
+  private
+
+  def method_missing(method, *args)
+    if method =~ /_root$/
+      root_uri ENV[method.to_s.sub(/_root$/, '_HOST').upcase], '/api/v1'
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    method.to_s.ends_with?('_root') || super
+  end
+
+  def root_uri(host, path = '')
+    if host =~ /\.org|\.tech/
+      URI::HTTPS.build(host: host, path: path).to_s
+    else
+      URI::HTTP.build(host: host, path: path).to_s
+    end
+  end
+end

data/lib/prx_access/version.rb

@@ -0,0 +1,3 @@
+module PRXAccess
+  VERSION = "0.1.0"
+end

data/prx_access.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "prx_access/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "prx_access"
+  spec.version       = PRXAccess::VERSION
+  spec.authors       = ["Sam Vevang"]
+  spec.email         = ["sam.vevang@prx.org"]
+
+  spec.summary       = %q{PRX Access navigates HAL hypermedia resources on PRX services.}
+  spec.description   = %q{PRX Access is a gem to supply authentication headers and descend the HAL hypermedia link tree on PRX's APIs.}
+  spec.homepage      = "https://github.com/PRX/prx_access"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/PRX/prx_access"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hyperresource", "~> 0.9.4"
+  spec.add_dependency "activesupport", ">= 4.0.0"
+
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: prx_access
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Vevang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hyperresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: pry
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: PRX Access is a gem to supply authentication headers and descend the
+  HAL hypermedia link tree on PRX's APIs.
+email:
+- sam.vevang@prx.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/prx_access.rb
+- lib/prx_access/prx_hyper_resource.rb
+- lib/prx_access/version.rb
+- prx_access.gemspec
+homepage: https://github.com/PRX/prx_access
+licenses: []
+metadata:
+  homepage_uri: https://github.com/PRX/prx_access
+  source_code_uri: https://github.com/PRX/prx_access
+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: PRX Access navigates HAL hypermedia resources on PRX services.
+test_files: []