openlive 1.0.0

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in openlive.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Robert May
+
+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,42 @@
+# Openlive
+
+[![Code Climate](https://codeclimate.com/github/piratestudios/openlive/badges/gpa.svg)](https://codeclimate.com/github/piratestudios/openlive)
+
+This is an API wrapper for the OpenLIVE API, a music recording service.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openlive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openlive
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/openlive.
+
+
+## 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 "openlive"
+
+# 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

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/openlive.rb

@@ -0,0 +1,28 @@
+require "gem_config"
+require "openlive/version"
+require "openlive/oauth"
+require "openlive/base"
+
+module Openlive
+  include GemConfig::Base
+
+  with_configuration do
+    has :oauth_settings, classes: Hash, default: {
+      site: "https://staging-identity.openlive.co",
+      authorize_url: "/connect/authorize",
+      token_url: "/connect/token",
+      scope: "tenant"
+    }
+
+    has :oauth_credentials, classes: Hash, default: {
+      client_id: ENV['OPENLIVE_OAUTH_CLIENT_ID'],
+      client_secret: ENV['OPENLIVE_OAUTH_CLIENT_SECRET'],
+    }
+
+    has :default_headers, classes: Hash, default: {}
+    has :base_uri, classes: String, default: (ENV['OPENLIVE_BASE_URI'] || "https://api.openlive.co/v1")
+  end
+
+  class Error < StandardError; end
+  class APIError < Error; end
+end

data/lib/openlive/artist.rb

@@ -0,0 +1,47 @@
+module Openlive
+  class Artist < Base
+    class << self
+      # Find and return an artist record
+      #
+      # @param id [String]
+      # @return [Artist]
+      # @raise [APIError] Will raise an error on unsuccessful response
+      def find(id)
+        response = Request.get("artists/#{id}")
+
+        handle_response(response, error_class: APIError) do |response|
+          new(response.body, response: response)
+        end
+      end
+
+      # Create a new artist on Openlive
+      #
+      # @param [Hash] attributes A hash of attributes to set
+      # @option attributes [String] :name
+      # @option attributes [String] :userId
+      # @return [Artist] the created artist object
+      # @raise [APIError] Will raise an error on unsuccessful response
+      def create(attributes)
+        response = Request.post("artists", attributes)
+
+        handle_response(response, error_class: APIError) do |response|
+          new(response.body, response: response)
+        end
+      end
+
+      # Fetch and return a list of all artists
+      #
+      # @return [Array<Artist>]
+      # @raise [APIError] Will raise an error on unsuccessful response
+      def all
+        response = Request.get("artists")
+
+        handle_response(response, error_class: APIError) do |response|
+          response.body['data'].map do |a|
+            new(a, response: response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openlive/base.rb

@@ -0,0 +1,113 @@
+module Openlive
+  class Base
+    extend Forwardable
+
+    # @return [Hash] a hash of data returned from the API
+    attr_accessor :api_data
+
+    # Convenience method for accessing the API response data
+    attr_accessor :response
+
+    # Initialize an instance (used by subclasses) with API data
+    #
+    # @param data [Hash]
+    # @return [Hash] the API data
+    def initialize(data, response: nil)
+      self.api_data = data
+      self.response = response
+    end
+
+    # Instance convenience method for the connection
+    #
+    # @return [Faraday::Connection]
+    def connection
+      self.class.connection
+    end
+
+    # Instance convenience method for oauth instance
+    #
+    # @return [Openlive::OAuth]
+    def oauth
+      self.class.oauth
+    end
+
+    # Refetch data from the API and update existing attributes
+    #
+    # @return [self]
+    def refresh
+      new_data = self.class.find(id)
+      self.api_data = new_data.api_data
+      self.response = new_data.response
+      self
+    end
+
+    # Pass method calls through to the API data
+    def method_missing(name, *args, &block)
+      if api_data.is_a?(Hash)
+        api_data[name.to_s]
+      end
+    end
+
+    class << self
+      # Faraday connection
+      #
+      # @return [Faraday::Connection]
+      def connection
+        @connection ||= (
+          conn = Faraday.new(url: Openlive.configuration.base_uri) do |faraday|
+            faraday.request  :url_encoded
+            faraday.response :logger
+            faraday.adapter  Faraday.default_adapter
+          end
+
+          conn.authorization(:Bearer, oauth.token.token)
+          conn.url_prefix = Openlive.configuration.base_uri
+          conn
+        )
+      end
+
+      # OAuth handler
+      #
+      # @return [Openlive::OAuth]
+      def oauth
+        @oauth ||= OAuth.new
+      end
+
+      # Raise an exception or execute the following block,
+      # used for generic error handling for all routes
+      #
+      # @param response [Response]
+      # @param error_class [OpenliveError]
+      # @param message [String] an optional message for the exception if raised
+      # @yield [Response] Block called for success condition
+      # @raise [OpenliveError] Will raise an error on unsuccessful response
+      def handle_response(response, error_class: Openlive::Error, message: nil, &block)
+        message = case
+        when !message.nil?
+          message
+        when error_class == Openlive::APIError
+          "endpoint returned a #{response.status} status: #{response.body}"
+        end
+
+        case
+        when response.success?
+          block.call(response)
+        when response.status == 404
+          nil
+        else
+          raise error_class, message
+        end
+
+      rescue Exception => ex
+        raise error_class, ex.message
+      end
+    end
+  end
+end
+
+require "openlive/request"
+require "openlive/response"
+require "openlive/artist"
+require "openlive/booking"
+require "openlive/master_builder"
+require "openlive/user"

data/lib/openlive/booking.rb

@@ -0,0 +1,68 @@
+module Openlive
+  class Booking < Base
+    # Convenience method for deleting this booking
+    #
+    # @return [Truthy] whether the record was successfully deleted or not
+    # @raise [APIError] Will raise an error on unsuccessful response
+    def delete
+      self.class.delete(id)
+    end
+
+    class << self
+      # Find and return a booking record
+      #
+      # @param id [String]
+      # @return [Booking]
+      # @raise [APIError] Will raise an error on unsuccessful response
+      def find(id)
+        response = Request.get("bookings/#{id}")
+
+        handle_response(response, error_class: APIError) do |response|
+          new(response.body, response: response)
+        end
+      end
+
+      # Create a new booking on Openlive
+      #
+      # @param [Hash] attributes A hash of attributes to set
+      # @option attributes [String] :artistId
+      # @option attributes [String] :masterbuilderId
+      # @option attributes [Time] :start
+      # @option attributes [Time] :finish
+      # @return [Booking] the created booking object
+      # @raise [APIError] Will raise an error on unsuccessful response
+      def create(attributes)
+        response = Request.post("bookings", format_attributes(attributes))
+
+        handle_response(response, error_class: APIError) do |response|
+          new(response.body, response: response)
+        end
+      end
+
+      # Delete an existing booking on Openlive
+      #
+      # @param [String] id The booking ID
+      # @return [Truthy] whether the record was successfully deleted or not
+      # @raise [APIError] Will raise an error on unsuccessful response
+      def delete(id)
+        response = Request.delete("bookings/#{id}")
+
+        handle_response(response, error_class: APIError) do |response|
+          response.response.success?
+        end
+      end
+
+      private
+
+      def format_attributes(attributes)
+        attributes.update(attributes) do |key, val|
+          if val.is_a?(Time) || val.is_a?(DateTime)
+            val.strftime("%Y-%m-%dT%H:%M:%S.%LZ")
+          else
+            val
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openlive/master_builder.rb

@@ -0,0 +1,32 @@
+module Openlive
+  class MasterBuilder < Base
+    class << self
+      # Find and return a masterbuilder record
+      #
+      # @param id [String]
+      # @return [MasterBuilder]
+      # @raise [APIError] Will raise an error on unsuccessful response
+      def find(id)
+        response = Request.get("masterbuilders/#{id}")
+
+        handle_response(response, error_class: APIError) do |response|
+          new(response.body, response: response)
+        end
+      end
+
+      # Fetch and return a list of all master builder units
+      #
+      # @return [Array<MasterBuilder>]
+      # @raise [APIError] Will raise an error on unsuccessful response
+      def all
+        response = Request.get("masterbuilders")
+
+        handle_response(response, error_class: Openlive::APIError) do |response|
+          response.body['data'].map do |mb|
+            new(mb, response: response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openlive/oauth.rb

@@ -0,0 +1,46 @@
+require "oauth2"
+require "oauth2/access_token"
+
+module Openlive
+  class OAuth
+    # @return [OAuth2::AccessToken] Used to store the existing token
+    attr_accessor :current_token
+
+    # Return or instantiate the OAuth client
+    #
+    # @return [OAuth2::Client]
+
+    def client
+      @client ||= (
+        credentials = Openlive.configuration.oauth_credentials
+
+        OAuth2::Client.new(
+          credentials[:client_id],
+          credentials[:client_secret],
+          Openlive.configuration.oauth_settings
+        )
+      )
+    end
+
+    # Return an existing unexpired token for this OAuth instance
+    # or requisition a new one from the server.
+    #
+    # @return [OAuth2::AccessToken]
+
+    def token
+      if current_token.nil? || current_token.expired?
+        requisition_token
+      else
+        current_token
+      end
+    end
+
+    # Fetch a new token from the OAuth server
+    #
+    # @return [OAuth2::AccessToken]
+
+    def requisition_token
+      self.current_token = client.client_credentials.get_token(scope: Openlive.configuration.oauth_settings[:scope])
+    end
+  end
+end