arc_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd563fb928d3234e0a67360b3a201de7fd2768866e5dc8e5c5b5d234db4b8c9e
+  data.tar.gz: c65c7cf0ef8f40e2e5fd8e3eb6fe3299a452be30495dfe4b04e71245c8e47833
+SHA512:
+  metadata.gz: 1e37df832a1292bc320b22801d9eb394dbcff997d01a7884c2e239406b1bcec92e3014ddaf61d6669a7983aeee029223440e2603710a12ffafde3fa8243416d2
+  data.tar.gz: d56bea8a3e8915a9f80735e7646fc7aab5c6f5002f6e6159db4b22a227187d0cb76a747279761212a7497bc80bed3cfc5b7bbdf339a51886570dc967734aac7c

data/Rakefile

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

data/arc_api.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+# spec/fixtures/bearcat.jpg Attribution: TassiloRau at the German language Wikipedia
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arc_api/version'
+
+Gem::Specification.new do |gem|
+  gem.authors =       ['Colin Cromar']
+  gem.email =         ['colincromar@gmail.com']
+  gem.description =   %q{Ruby interface for interacting with the Arc API}
+  gem.summary =       %q{Canvas API}
+
+  gem.files = %w[Rakefile arc_api.gemspec]
+  gem.files += Dir.glob('lib/**/*.rb')
+  gem.files += Dir.glob('spec/**/*')
+  gem.test_files    = Dir.glob('spec/**/*')
+  gem.name          = 'arc_api'
+  gem.require_paths = ['lib']
+  gem.version       = ArcApi::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'bundler', '>= 1.0.0'
+  gem.add_development_dependency 'rspec', '>= 3.0'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'pry'
+
+  gem.add_dependency 'footrest', '>= 0.5.1'
+end

data/lib/arc_api.rb

@@ -0,0 +1,2 @@
+require 'arc_api/version'
+require 'arc_api/client'

data/lib/arc_api/client.rb

@@ -0,0 +1,45 @@
+require 'footrest/client'
+module ArcApi
+  class Client < Footrest::Client
+    require 'arc_api/client/media'
+    require 'arc_api/client/health_check'
+
+    include Media
+    include HealthCheck
+
+    API_PATH = '/api/public/v1'.freeze
+    MEDIA_PATH = '/media'.freeze
+    UPLOADS_PATH = '/uploads'.freeze
+    COMPLETE_PATH = '/complete'.freeze
+    HEALTH_CHECK_PATH = '/ping'.freeze
+
+    def set_connection(config)
+      config[:logger] = config[:logging] if config[:logging]
+      raise 'No client prefix url provided - must provide prefix' if config[:prefix].nil? || config[:prefix].empty?
+      @connection = Faraday.new(url: config[:prefix]) do |faraday|
+        faraday.use                         Footrest::FollowRedirects, limit: 5 unless config[:follow_redirects] == false
+        faraday.use                         Footrest::ParseJson, content_type: /\bjson$/
+        faraday.use                         Footrest::RaiseFootrestErrors
+        faraday.use                         Footrest::Pagination
+        faraday.request                     :multipart
+        faraday.request                     :url_encoded
+        faraday.adapter                     Faraday.default_adapter
+
+        if config[:logger] == true
+          faraday.response :logger
+        elsif config[:logger]
+          faraday.use Faraday::Response::Logger, config[:logger]
+        end
+
+        faraday.headers[:accept] = 'application/json'
+        faraday.headers[:user_agent]      = 'Footrest'
+        if config[:token] && config[:user_id]
+          faraday.headers[:authorization] =  "Bearer user_id=\"#{config[:user_id]}\", token=\"#{config[:token]}\""
+        else
+          raise 'No api authorization provided - must provide token and user_id'
+        end
+      end
+    end
+  end
+
+end

data/lib/arc_api/client/health_check.rb

@@ -0,0 +1,10 @@
+module ArcApi
+  class Client < Footrest::Client
+    module HealthCheck
+      def health_check
+        @connection.headers['Accept'] = 'text/plain'
+        get(API_PATH + HEALTH_CHECK_PATH)
+      end
+    end
+  end
+end

data/lib/arc_api/client/media.rb

@@ -0,0 +1,34 @@
+module ArcApi
+  class Client < Footrest::Client
+    module Media
+      def initiate_media_upload(params = {})
+        post(API_PATH + MEDIA_PATH + UPLOADS_PATH, params)
+      end
+
+      def upload_file(params = {})
+        ext = File.extname(params[:file_path]).gsub!('.', '')
+        conn = Faraday.new do |f|
+          f.headers['Content-Type'] = "video/#{ext}"
+          f.request :multipart
+          f.request :url_encoded
+          f.adapter :httpclient
+        end
+
+        file = Faraday::UploadIO.new(params[:file_path], "video/#{ext}")
+        response = conn.put(params[:url], file)
+
+        return response.to_hash[:url].to_s
+      rescue StandardError => e
+        raise "File upload failed - #{e}"
+      end
+
+      def create_media(params = {})
+        post(API_PATH + MEDIA_PATH, params)
+      end
+
+      def complete_media_upload(params = {})
+        post(API_PATH + MEDIA_PATH + UPLOADS_PATH + "/#{params[:id]}" + COMPLETE_PATH, params)
+      end
+    end
+  end
+end

data/lib/arc_api/version.rb

@@ -0,0 +1,3 @@
+module ArcApi
+  VERSION = '0.1.0'
+end

data/spec/arc_api/client/health_check_spec.rb

@@ -0,0 +1,7 @@
+describe ArcApi::Client::HealthCheck do
+  before { set_client }
+
+  it 'returns pong' do
+    stub_get(@client, '/health_check').to_return(json_response('health_check.json'))
+  end
+end

data/spec/arc_api/client/media_spec.rb

@@ -0,0 +1,25 @@
+describe ArcApi::Client::Media do
+  before { set_client }
+
+  it 'initiates a media upload' do
+    resp = stub_post(@client, ('/media/uploads')).to_return(json_response('media_initiate_upload.json'))
+    data = JSON.parse(resp.response.body)
+    expect(data['upload']['id']).to eq(2890)
+  end
+
+  it 'creates a media object' do
+    resp = stub_post(@client, ('/media')).to_return(json_response('media_create.json'))
+    data = JSON.parse(resp.response.body)
+    expect(data['media']['id']).to eq(2893)
+    expect(data['media']['title']).to eq('Introduction to SAML')
+  end
+
+  it 'completes the media upload' do
+    media_id = 2892
+    resp = stub_post(@client, ("/media/uploads/#{media_id}/complete")).to_return(json_response('media_upload_completion.json'))
+    data = JSON.parse(resp.response.body)
+    expect(data['media']['id']).to eq(2892)
+    expect(data['media']['title']).to eq('OAuth Overview')
+    expect(data['media']['description']).to eq('A brief overview of how OAuth works')
+  end
+end

data/spec/arc_api/client_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+describe ArcApi::Client do
+  it 'sets the params' do
+    client = ArcApi::Client.new(prefix: "http://canvas.instructure.com", token: "token", user_id: 5)
+    expect(client.config[:prefix]).to eq("http://canvas.instructure.com")
+    expect(client.config[:token]).to eq("token")
+    expect(client.config[:user_id]).to eq(5)
+  end
+end

data/spec/arc_api_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe ArcApi do
+  it "has a version number" do
+    expect(ArcApi::VERSION).not_to be nil
+  end
+end

data/spec/fixtures/health_check.json

@@ -0,0 +1 @@
+"pong"

data/spec/fixtures/media_create.json

@@ -0,0 +1,7 @@
+{
+  "media": {
+    "id": 2893,
+    "title": "Introduction to SAML",
+    "description": "A brief overview of what's under the hood of a SAML provider"
+  }
+}

data/spec/fixtures/media_initiate_upload.json

@@ -0,0 +1,6 @@
+{
+  "upload": {
+    "id": 2890,
+    "url": "https://instructure-signal-bogus.s3.amazonaws.com/public_api_v1/43-2890?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=aws_key%2F20181102%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=bogus&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&X-Amz-Signature=bogus"
+  }
+}

data/spec/fixtures/media_upload_completion.json

@@ -0,0 +1,7 @@
+{
+  "media": {
+    "id": 2892,
+    "title": "OAuth Overview",
+    "description": "A brief overview of how OAuth works"
+  }
+}

data/spec/fixtures/media_url.json

@@ -0,0 +1 @@
+"https://instructure-signal-bogus.s3.amazonaws.com/public_api_v1/43-2892?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=bogus%bogus%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20181102T164343Z&X-Amz-Expires=86400&X-Amz-Signature=bogu&X-Amz-SignedHeaders=host"

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'bundler/setup'
+require 'arc_api'
+require 'rspec'
+require 'webmock/rspec'
+require 'json'
+require 'pry'
+
+WebMock.disable_net_connect!
+
+def fixture(*file)
+  File.new(File.join(File.expand_path("../fixtures", __FILE__), *file))
+end
+
+def stub_get(client, url)
+  stub_request(:get, "#{client.config[:prefix]}#{url}")
+end
+
+def stub_post(client, url)
+  stub_request(:post, "#{client.config[:prefix]}#{url}")
+end
+
+def stub_put(client, url)
+  stub_request(:put, "#{client.config[:prefix]}#{url}")
+end
+
+def stub_delete(client, url)
+  stub_request(:delete, "#{client.config[:prefix]}#{url}")
+end
+
+def json_response(*file)
+  {
+    :body => fixture(*file),
+    :headers => {
+      :content_type => 'application/json; charset=utf-8'
+    }
+  }
+end
+
+def set_client
+  @client = ArcApi::Client.new(prefix: "https://ccromar.instructuremedia.com",
+                               token: "token", user_id: 5)
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: arc_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Colin Cromar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.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: 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: footrest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+description: Ruby interface for interacting with the Arc API
+email:
+- colincromar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- arc_api.gemspec
+- lib/arc_api.rb
+- lib/arc_api/client.rb
+- lib/arc_api/client/health_check.rb
+- lib/arc_api/client/media.rb
+- lib/arc_api/version.rb
+- spec/arc_api/client/health_check_spec.rb
+- spec/arc_api/client/media_spec.rb
+- spec/arc_api/client_spec.rb
+- spec/arc_api_spec.rb
+- spec/fixtures/health_check.json
+- spec/fixtures/media_create.json
+- spec/fixtures/media_initiate_upload.json
+- spec/fixtures/media_upload_completion.json
+- spec/fixtures/media_url.json
+- spec/spec_helper.rb
+homepage: 
+licenses: []
+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.7
+signing_key: 
+specification_version: 4
+summary: Canvas API
+test_files:
+- spec/spec_helper.rb
+- spec/arc_api_spec.rb
+- spec/fixtures/media_url.json
+- spec/fixtures/media_create.json
+- spec/fixtures/health_check.json
+- spec/fixtures/media_upload_completion.json
+- spec/fixtures/media_initiate_upload.json
+- spec/arc_api/client_spec.rb
+- spec/arc_api/client/media_spec.rb
+- spec/arc_api/client/health_check_spec.rb