catalog-api-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b7b985d70756f8b90456994d607b93b373d28dc
+  data.tar.gz: d9a38398cf14865782fe9bc217ef08b2406be425
+SHA512:
+  metadata.gz: 7bf8cfc620f13a324e6c01a5537475d645f4d4f5401aef53335ace0e7940959ed94798a3a5470067ec8a0d634f96407ebc9a0dd5c486e8b3753cedf80b5c7fac
+  data.tar.gz: b94d37a509b66e1484c24d83bc665f2446e6ee3fe8d607e1a3e384223a7995079860e884232c8c0f6029fa0bbf682d0ef4a8a803c99b35e267071c92aec749f6

data/lib/catalog/api/client.rb

@@ -0,0 +1,107 @@
+require 'catalog/api/version'
+require 'rest-client'
+require 'securerandom'
+require 'link_header'
+
+module Catalog
+  module Api
+    class Client
+      def initialize(opts = {})
+        if opts[:host].include? ':'
+          @host, @port = opts[:host].split(':')
+        else
+          @host = opts[:host]
+        end
+        @scheme = opts[:scheme] || 'https'
+        @port ||= (@scheme == 'https') ? 443 : 80
+        @token = opts[:token]
+        @version = opts[:version] || 'v1'
+        @auth_header = {
+          Authorization: "Token token=#{@token}",
+          content_type: 'application/json'
+        }
+        @api_path = "/api/#{@version}"
+      end
+
+      [:get, :post, :put, :delete].each do |method|
+        define_method method do |resource, options = { resource_id: nil, request_body: nil }|
+          delegate(method, resource, options)
+        end
+      end
+
+      private
+
+      def delegate(method, resource, options)
+        paginate?(method, options) ? paginated_request(options, resource) : request(method, resource, options)
+      end
+
+      def paginate?(method, options)
+        (method.eql? :get) && (options[:resource_id].nil?)
+      end
+
+      def request(method, resource, options)
+        path = uri(resource, options[:resource_id])
+        call_api(method, path, options[:request_body]).last # return response body w/o header
+      end
+
+      def paginated_request(options, resource)
+        path = uri(resource)
+        headers, body = call_api(:get, path)
+        return body if body.empty?
+
+        cur_page_index = 1
+        path = next_page(headers)
+        while path && pages?(cur_page_index, options[:max_pages])
+          headers, paginated_body = call_api(:get, path)
+          body.concat paginated_body
+          cur_page_index += 1
+          path = next_page(headers)
+        end
+
+        body
+      end
+
+      def uri(resource, resource_id = nil)
+        URI::Generic.build(
+          scheme: @scheme,
+          host:   @host,
+          port:   @port.to_i,
+          path:   [@api_path, resource, resource_id].compact.join('/')
+        ).to_s
+      end
+
+      def headers_and_body(response)
+        parsed_response = JSON.parse(response) rescue {}
+        headers = response.headers
+        body = if parsed_response.size == 1
+                 parsed_response.first.last
+               else
+                 parsed_response
+               end
+        [headers, body]
+      end
+
+      def pages?(cur_page_index, max_page)
+        max_page.nil? || cur_page_index < max_page
+      end
+
+      def call_api(method, path, request_body = nil)
+        response =
+        case method
+        when :delete, :get
+          RestClient.send(method, path, @auth_header)
+        when :post, :put
+          RestClient.send(method, path, request_body, @auth_header)
+        else
+          fail "Invalid method: #{method}"
+        end
+        headers_and_body(response)
+      end
+
+      def next_page(headers)
+        links = LinkHeader.parse(headers[:link]).links
+        next_link = links.find { |link| link['rel'] == 'next' } and next_link.href
+      end
+    end
+  end
+end

data/lib/catalog/api/version.rb

@@ -0,0 +1,5 @@
+module Catalog
+  module Api
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: catalog-api-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Santosh Natarajan
+- Dave Donahue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: link_header
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " Ruby client for catalog api "
+email:
+- snatarajan@instructure.com
+- ddonahue@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/catalog/api/client.rb
+- lib/catalog/api/version.rb
+homepage: https://github.com/instructure/catalog_api_client
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby client for catalog api
+test_files: []