brightcove-cmsapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30e2e95b6fa46f8dc97092182f230b0c7a176002
+  data.tar.gz: 7f6b5104c142e2ccfc4758b0a9f893edf8549706
+SHA512:
+  metadata.gz: 15222de1bbcd9ed0e009a42dd0c3fc7ef4aeb14cc06cd3fbcdda697c700525c4f10e682874d0459e0427bf30f0426c3b33d25ad926a110d770c3da683fc46366
+  data.tar.gz: 4b6fc1e5201125727f4a03d07c607e98149f8d9f9b1f632bdd506a2417744683ed82d656d08309fb898bdbacd6f4f6b4ad0eeae4c0093e5a08e995f58a724c5d

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in brightcove-cmsapi.gemspec
+gemspec
+
+group :development, :test do
+  gem "rake", "~> 10.0"
+end
+
+group :test do
+  gem "rspec", "~> 3.0"
+  gem "webmock", "~> 3.0.1"
+  gem "timecop", "~> 0.9.1"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Daniel King
+
+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,95 @@
+# Brightcove::Cmsapi
+
+[![Build Status](https://travis-ci.org/nhsuk/brightcove-cmsapi.svg?branch=master)](https://travis-ci.org/nhsuk/brightcove-cmsapi)
+
+This gem wraps Brightcove's [CMS API](https://brightcovelearning.github.io/Brightcove-API-References/cms-api/v1/doc/index.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brightcove-cmsapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brightcove-cmsapi
+
+## Setup 
+
+To use this library you will require a client ID and secret, as well as your brightcove account's ID.
+You can find instructions of obtaining these credentials in the [Brightcove docs](https://support.brightcove.com/managing-api-authentication-credentials).
+
+** Setup a basic client **
+
+```ruby
+  @client = Brightcove::Cmsapi.new(
+    account_id: "my_account_id",
+    client_id: "my_client_id",
+    client_secret: "my_client_secret")
+```
+
+One alternative to this setup that can save you time and boilerplate code would be to call the `.default_api` method.
+This assumes you have your credentials and account ID set as environment variables `BRIGHTCOVE_ACCOUNT_ID` `BRIGHTCOVE_CLIENT_ID` `BRIGHTCOVE_CLIENT_SECRET`.
+
+** Alternatively: don't setup the client each time (RECOMMENDED USAGE) **
+
+```ruby
+Brightcove::Cmsapi.default_api.get('videos')
+```
+
+## Usage examples
+
+** Get the available videos in account (by default the first 20) **
+
+```ruby
+@client.get('videos')
+
+# or use the default_api setup:
+Brightcove::Cmsapi.default_api.get('videos')
+```
+
+Calling `.get` uses the default API settings and simply appends the argument to the API call like this:
+
+`https://cms.api.brightcove.com/v1/accounts/:account_id/videos`
+
+The result will be a `HTTP::Response` object (the gem uses the [http.rb gem](https://github.com/httprb/http)).
+To parse the JSON in this response into a Ruby hash call `.parse`.
+
+The API defaults are described in [Brightcove's documentation](https://brightcovelearning.github.io/Brightcove-API-References/cms-api/v1/doc/index.html).
+To get more than the default 20 results you could call `.get('videos?limit=100')`, however there is a hard limit at 100 results that you can not exceed.
+To get around this limit you can use the `.get_all` method as displayed below, this will paginate through the results and return a parsed set of all
+a particular resource.
+
+** Get all available videos **
+
+```ruby
+Brightcove::Cmsapi.default_api.get_all('video')
+```
+
+** Get all available videos in a folder **
+
+```ruby
+Brightcove::Cmsapi.default_api.get_all('folder/:folder_id', 'video')
+```
+
+** Get all available videos in a folder as an array of ruby hashes **
+
+```ruby
+Brightcove::Cmsapi.default_api.get_all('folder/:folder_id', 'video').parse
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "brightcove/cmsapi"
+
+# 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/brightcove-cmsapi.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "brightcove-cmsapi"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Daniel King"]
+  spec.email         = ["daniel.king5@nhs.net"]
+
+  spec.summary       = %q{A simple wrapper around Brightcove's CMS API}
+  spec.homepage      = "https://nhs.uk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.required_ruby_version = '~> 2.3.1'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_runtime_dependency "http", "~> 2.2.2"
+end

data/lib/brightcove/cmsapi.rb

@@ -0,0 +1,61 @@
+require "http"
+
+module Brightcove
+  class Cmsapi
+    OAUTH_ENDPOINT = "https://oauth.brightcove.com/v4/access_token"
+    API_ROOT = "https://cms.api.brightcove.com/v1/accounts"
+
+    def initialize(account_id:, client_id:, client_secret:)
+      @base_url = "#{API_ROOT}/#{account_id}"
+      @client_id = client_id
+      @client_secret = client_secret
+      set_token
+    end
+
+    def self.default_api
+      @default_api ||= new(
+        account_id: ENV['BRIGHTCOVE_ACCOUNT_ID'],
+        client_id: ENV['BRIGHTCOVE_CLIENT_ID'],
+        client_secret: ENV['BRIGHTCOVE_CLIENT_SECRET'])
+    end
+
+    def get(path)
+      set_token if @token_expires < Time.now
+      response = HTTP.auth("Bearer #{@token}").get("#{@base_url}/#{path}")
+
+      if response.code == 401 # Unauthorized, token expired
+        set_token
+        HTTP.auth("Bearer #{@token}").get("#{@base_url}/#{path}")
+      else
+        response
+      end
+    end
+
+    def get_all(path="", resource)
+      if path.empty?
+        count = get("counts/#{resource}s").parse.fetch("count")
+        resource_path = "#{resource}s"
+      else
+        count = get(path).parse.fetch("#{resource}_count")
+        resource_path = "#{path}/#{resource}s"
+      end
+      offset = 0
+      resources = []
+      while offset < count do
+        resources.concat(get("#{resource_path}?limit=100&offset=#{offset}").parse)
+        offset = offset + 100
+      end
+      resources
+    end
+
+    private
+
+    def set_token
+      response = HTTP.basic_auth(user: @client_id, pass: @client_secret)
+                     .post(OAUTH_ENDPOINT,
+                           form: { grant_type: "client_credentials" }).parse
+      @token = response.fetch("access_token")
+      @token_expires = Time.now + response.fetch("expires_in")
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: brightcove-cmsapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel King
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+description: 
+email:
+- daniel.king5@nhs.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brightcove-cmsapi.gemspec
+- lib/brightcove/cmsapi.rb
+homepage: https://nhs.uk
+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.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A simple wrapper around Brightcove's CMS API
+test_files: []