bridge_api 0.1.20 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bce329056305672b1df2fcdc6c87a60bdbc73202
-  data.tar.gz: f7c19e775975de6873784c6fe6ad283bc2004285
+  metadata.gz: 23e484eca3a30379d5ea34f5cad98d315a1ddb74
+  data.tar.gz: bbd7dc872d31056ee05dc05c3f3c3642b27a260d
 SHA512:
-  metadata.gz: 1198ac3d96bb9dfc31eb30fddd422561f64af2fce5a4d9a92a800f99b105100d57dba1400a902fe213aaadd9cacf013b958f6948cacb299c10493fe290a6f76f
-  data.tar.gz: 9724c5b3ea3f44ce435f35f9797f9fb63b64110fb0ceb0efbd22a446161d4e960703818ab2c5f588eb56c7d58c78fe48d2ddae0d122ccc2e193793c8a0489842
+  metadata.gz: c3c1314b45b45f6c01d1b41ce790b9b11dc2feef7e192e759ff0a8352f7080328aee978cf388e729f1c1db2fa3543523ca8f3090f7d06a732217fa44e4a25f30
+  data.tar.gz: 598319ec388b85afb5acbd47fb4790d6c659c3129c23706dd47e7a9fdd73f92d3d5326fa614a6da7ad68ce04e78789e29f25d53aee3ea21ff67c72bcd51d001d

data/Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:2.5.0
+
+RUN apt-get update
+
+RUN mkdir -p /usr/src/app
+COPY Gemfile /usr/src/app/
+COPY Gemfile.lock /usr/src/app/
+COPY bridge_api.gemspec /usr/src/app/
+COPY /lib/bridge_api/version.rb /usr/src/app/lib/bridge_api/
+
+WORKDIR /usr/src/app
+RUN bundle install --system
+
+COPY . /usr/src/app/

data/Gemfile

@@ -1,2 +1,2 @@
 source 'https://rubygems.org'
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bridge_api (0.1.19)
+    bridge_api (0.1.20)
       faraday (~> 0.9.0)
       faraday_middleware (~> 0.9.0)
       footrest (>= 0.5.1)
@@ -9,9 +9,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.5)
+    activesupport (5.2.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.5.1)
@@ -31,7 +31,7 @@ GEM
       faraday (~> 0.9.0)
       link_header (>= 0.0.7)
     hashdiff (0.3.2)
-    i18n (0.9.5)
+    i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     link_header (0.0.8)
     method_source (0.8.2)

data/bin/jenkins

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+set +e
+EXIT_CODES=0
+
+#Skip this for now until we can fix all the cop issues
+
+#echo "Analyzing ruby code with rubocop"
+#bundle exec gergich capture rubocop "bundle exec rubocop --fail-level autocorrect"
+#EXIT_CODES=$(($EXIT_CODES + $?))
+
+echo 'Running ruby specs'
+bundle exec rspec
+EXIT_CODES=$(($EXIT_CODES + $?))
+
+bundle exec gergich publish
+exit $EXIT_CODES

data/bridge_api.gemspec

@@ -1,34 +1,33 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'bridge_api/version'
 
 Gem::Specification.new do |gem|
-  gem.authors =       ["Jay Shaffer"]
-  gem.email =         ["jshaffer@instructure.com"]
-  gem.description =   %q{Ruby gem for interacting with the bridge API}
-  gem.summary =       %q{Bridge API}
-  gem.homepage =      "https://getbridge.com"
+  gem.authors =       ['Jay Shaffer']
+  gem.email =         ['jshaffer@instructure.com']
+  gem.description =   'Ruby gem for interacting with the bridge API'
+  gem.summary =       'Bridge API'
+  gem.homepage =      'https://getbridge.com'
   gem.license = 'MIT'
 
   gem.files = `git ls-files`.split("\n")
-  gem.files += Dir.glob("lib/**/*.rb")
-  gem.files += Dir.glob("spec/**/*")
-  gem.test_files    = Dir.glob("spec/**/*")
-  gem.name          = "bridge_api"
-  gem.require_paths = ["lib"]
+  gem.files += Dir.glob('lib/**/*.rb')
+  gem.files += Dir.glob('spec/**/*')
+  gem.test_files    = Dir.glob('spec/**/*')
+  gem.name          = 'bridge_api'
+  gem.require_paths = ['lib']
   gem.version       = BridgeAPI::VERSION
 
-  gem.add_development_dependency 'rake', '~> 0'
   gem.add_development_dependency 'bundler', '~> 1.0', '>= 1.0.0'
-  gem.add_development_dependency 'rspec', '~> 2.6'
-  gem.add_development_dependency 'webmock', '~>1.22.6'
+  gem.add_development_dependency 'byebug', '~> 8.2.2'
   gem.add_development_dependency 'pry', '~> 0'
-  gem.add_development_dependency 'tilt', '>= 1.3.4', '~> 1.3'
+  gem.add_development_dependency 'rake', '~> 0'
+  gem.add_development_dependency 'rspec', '~> 2.6'
   gem.add_development_dependency 'sinatra', '~> 1.0'
-  gem.add_development_dependency 'byebug', '~> 8.2.2'
+  gem.add_development_dependency 'tilt', '>= 1.3.4', '~> 1.3'
+  gem.add_development_dependency 'webmock', '~>1.22.6'
 
-  gem.add_dependency 'footrest', '>= 0.5.1'
   gem.add_dependency 'faraday', '~> 0.9.0'
   gem.add_dependency 'faraday_middleware', '~> 0.9.0'
-
+  gem.add_dependency 'footrest', '>= 0.5.1'
 end

data/build.sh

@@ -0,0 +1,5 @@
+set -e
+
+docker-compose build
+docker-compose up -d
+docker-compose run -T web bin/jenkins

data/docker-compose.yml

@@ -0,0 +1,18 @@
+version: '2'
+
+services:
+  web:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    environment:
+      APP_DOMAIN: web
+      GERGICH_KEY: "${GERGICH_KEY}"
+      GERRIT_PROJECT: "${GERRIT_PROJECT}"
+      GERRIT_HOST: "${GERRIT_HOST}"
+      GERRIT_BRANCH: "${GERRIT_BRANCH}"
+    volumes:
+      - "coverage:/usr/src/app/coverage"
+
+volumes:
+  coverage: {}

data/lib/bridge_api/api_array.rb

@@ -6,14 +6,14 @@ module BridgeAPI
     @next_page = nil
     @prev_page = nil
 
-    attr_reader :status, :headers, :members, :body, :errors
+    attr_reader :status, :headers, :members, :body, :errors, :meta, :linked
 
     def self.process_response(response, api_client, result_mapping)
       ApiArray.new(response, api_client, result_mapping)
     end
 
     def initialize(response, api_client, result_mapping)
-      @meta_fields = %w(meta linked)
+      @meta_fields = %w[meta linked]
       @api_client = api_client
       @linked = {}
       @meta = {}
@@ -26,13 +26,11 @@ module BridgeAPI
         mapping_exists = result_mapping.key?(matches[1])
         mapping = result_mapping[matches[1]] if mapping_exists
       end
-      unless mapping.nil?
-        @extra_meta_fields.concat(mapping[:meta])
-      end
+      @extra_meta_fields.concat(mapping[:meta]) unless mapping.nil?
       case response.status
-        when *((200..206).to_a + [302])
-          apply_response_metadata(response)
-          @members = get_response_content(response)
+      when *((200..206).to_a + [302])
+        apply_response_metadata(response)
+        @members = get_response_content(response)
       else
         set_response_vars(response)
       end
@@ -40,9 +38,13 @@ module BridgeAPI
 
     def set_response_vars(response)
       @headers = response.headers
-      @status= response.status
-      @body= response.body
-      @errors = response.body['errors']  rescue []
+      @status = response.status
+      @body = response.body
+      @errors = begin
+                  response.body['errors']
+                rescue StandardError
+                  []
+                end
     end
 
     def length
@@ -57,33 +59,26 @@ module BridgeAPI
       @members.last
     end
 
-    def each(&block)
-      @members.each { |member| block.call(member) }
+    def each
+      @members.each { |member| yield(member) }
     end
 
     def pages?
       !@next_page.nil?
     end
 
-    def meta
-      @meta
-    end
-
-    def linked
-      @linked
-    end
 
     def next_page
       load_page(@next_page)
     end
 
-    def each_page(&block)
-      block.call(@members, @linked, @meta)
+    def each_page
+      yield(@members, @linked, @meta)
       while @next_page
         response = get_page(@next_page)
         apply_response_metadata(response, false)
         @members = get_response_content(response)
-        block.call(@members, @linked, @meta)
+        yield(@members, @linked, @meta)
       end
       @link_hash = {}
     end
@@ -121,10 +116,8 @@ module BridgeAPI
 
     def get_response_content(response)
       return [] unless response.body.is_a?(Hash)
-      content = response.body.reject{|k, v| @meta_fields.include?(k) || @extra_meta_fields.include?(k)}
-      if content.length > 0
-        return content.values[0]
-      end
+      content = response.body.reject { |k, _v| @meta_fields.include?(k) || @extra_meta_fields.include?(k) }
+      return content.values[0] unless content.empty?
       []
     end
 
@@ -142,13 +135,13 @@ module BridgeAPI
 
     def init_linked(response)
       if response.body.is_a?(Hash) && response.body.key?('linked')
-        @linked = @linked.merge(response.body['linked']){|key,oldval,newval| [*oldval].to_a + [*newval].to_a }
+        @linked = @linked.merge(response.body['linked']) { |_key, oldval, newval| [*oldval].to_a + [*newval].to_a }
       end
     end
 
     def init_meta(response)
       if response.body.is_a?(Hash) && response.body.key?('meta')
-        @meta = @meta.merge(response.body['meta']){|key,oldval,newval| [*oldval].to_a + [*newval].to_a }
+        @meta = @meta.merge(response.body['meta']) { |_key, oldval, newval| [*oldval].to_a + [*newval].to_a }
         @extra_meta_fields.each do |field|
           @meta[field] = response.body[field]
         end
@@ -167,6 +160,5 @@ module BridgeAPI
         end
       end
     end
-
   end
 end

data/lib/bridge_api/client.rb

@@ -9,36 +9,37 @@ require 'base64'
 
 module BridgeAPI
   class Client < Footrest::Client
-
-    DATA_DUMP_DOWNLOAD_PATH = '/data_dumps/download'
-    DATA_DUMP_PATH = '/data_dumps'
-    COURSE_TEMPLATE_PATH = '/course_templates'
-    ENROLLMENT_PATH = '/enrollments'
-    PROGRAM_PATH = '/programs'
-    PROGRAM_ENROLLMENT_PATH = '/learners'
-    USER_PATH = '/users'
-    GROUPS_PATH = '/groups'
-    MANAGER_PATH = '/managers'
-    ADMIN_PATH = "/admin"
-    AUTHOR_PATH = "/author"
-    LEARNER_PATH = "/learner"
-    CUSTOM_FIELD_PATH = "/custom_fields"
-    SUB_ACCOUNT_PATH = '/sub_accounts'
+    DATA_DUMP_DOWNLOAD_PATH = '/data_dumps/download'.freeze
+    DATA_DUMP_PATH = '/data_dumps'.freeze
+    COURSE_TEMPLATE_PATH = '/course_templates'.freeze
+    ENROLLMENT_PATH = '/enrollments'.freeze
+    PROGRAM_PATH = '/programs'.freeze
+    PROGRAM_ENROLLMENT_PATH = '/learners'.freeze
+    USER_PATH = '/users'.freeze
+    GROUPS_PATH = '/groups'.freeze
+    MANAGER_PATH = '/managers'.freeze
+    ADMIN_PATH = '/admin'.freeze
+    AUTHOR_PATH = '/author'.freeze
+    LEARNER_PATH = '/learner'.freeze
+    CUSTOM_FIELD_PATH = '/custom_fields'.freeze
+    SUB_ACCOUNT_PATH = '/sub_accounts'.freeze
+    SUPPORT_PATH = '/support'.freeze
+    ACCOUNT_PATH = '/accounts'.freeze
     API_VERSION = 1
-    API_PATH = '/api'
-    ROLE_PATH = '/roles'
+    API_PATH = '/api'.freeze
+    ROLE_PATH = '/roles'.freeze
     RESULT_MAPPING = {}
 
     require 'bridge_api/api_array'
 
     Dir[File.dirname(__FILE__) + '/client/*.rb'].each do |file|
       require file
-      include self.const_get("#{File.basename(file).gsub('.rb','').split("_").map{|ea| ea.capitalize}.join('')}")
+      include const_get(File.basename(file).gsub('.rb', '').split('_').map(&:capitalize).join('').to_s)
     end
 
     # Override Footrest request for ApiArray support
     def request(method, &block)
-      ApiArray::process_response(connection.send(method, &block), self, RESULT_MAPPING)
+      ApiArray.process_response(connection.send(method, &block), self, RESULT_MAPPING)
     end
 
     def set_connection(config)
@@ -53,12 +54,12 @@ module BridgeAPI
         end
         faraday.use                         Footrest::FollowRedirects, limit: 5 unless config[:follow_redirects] == false
         faraday.adapter                     Faraday.default_adapter
-        faraday.use                         Footrest::ParseJson, :content_type => /\bjson$/
+        faraday.use                         Footrest::ParseJson, content_type: /\bjson$/
         faraday.use                         Footrest::RaiseFootrestErrors
         faraday.use                         Footrest::Pagination
-        faraday.headers[:accept]          = "application/json"
+        faraday.headers[:accept]          = 'application/json'
         faraday.headers[:authorization]   = "Bearer #{config[:token]}" if config[:token]
-        faraday.headers[:user_agent]      = "Footrest"
+        faraday.headers[:user_agent]      = 'Footrest'
         if config[:api_key] && config[:api_secret]
           faraday.headers[:authorization] =   'Basic ' + Base64.strict_encode64("#{config[:api_key]}:#{config[:api_secret]}")
         elsif config[:token]

data/lib/bridge_api/client/account.rb

@@ -0,0 +1,9 @@
+module BridgeAPI
+  class Client
+    module Account
+      def update_account(account_id, params = {})
+        put("#{API_PATH}#{SUPPORT_PATH}#{ACCOUNT_PATH}/#{account_id}", params)
+      end
+    end
+  end
+end

data/lib/bridge_api/client/course_template.rb

@@ -1,7 +1,6 @@
 module BridgeAPI
   class Client
     module CourseTemplate
-
       def get_all_course_templates(params = {})
         get("#{API_PATH}#{AUTHOR_PATH}#{COURSE_TEMPLATE_PATH}", params)
       end
@@ -25,7 +24,6 @@ module BridgeAPI
       def update_course_template(course_template_id, params = {})
         put("#{API_PATH}#{AUTHOR_PATH}#{COURSE_TEMPLATE_PATH}/#{course_template_id}", params)
       end
-
     end
   end
 end

data/lib/bridge_api/client/custom_field.rb

@@ -1,7 +1,6 @@
 module BridgeAPI
   class Client
     module CustomField
-
       def add_custom_field(params = {})
         post("#{API_PATH}#{AUTHOR_PATH}#{CUSTOM_FIELD_PATH}", params)
       end
@@ -21,7 +20,6 @@ module BridgeAPI
       def get_all_custom_fields(params = {})
         get("#{API_PATH}#{AUTHOR_PATH}#{CUSTOM_FIELD_PATH}", params)
       end
-
     end
   end
 end

data/lib/bridge_api/client/enrollment.rb

@@ -1,7 +1,6 @@
 module BridgeAPI
   class Client
     module Enrollment
-
       def add_enrollment(course_template_id, params = {})
         post("#{API_PATH}#{AUTHOR_PATH}#{COURSE_TEMPLATE_PATH}/#{course_template_id}#{ENROLLMENT_PATH}", params)
       end
@@ -21,7 +20,6 @@ module BridgeAPI
       def update_enrollment_due_date(enrollment_id, params = {})
         post("#{API_PATH}#{AUTHOR_PATH}#{ENROLLMENT_PATH}/#{enrollment_id}/due_date", params)
       end
-
     end
   end
 end

data/lib/bridge_api/client/live_course.rb

@@ -1,11 +1,9 @@
 module BridgeAPI
   class Client
     module LiveCourse
-
       def get_all_live_courses(params = {})
         get("#{API_PATH}#{AUTHOR_PATH}/live_courses", params)
       end
-
     end
   end
 end

data/lib/bridge_api/client/live_course_enrollment.rb

@@ -1,11 +1,9 @@
 module BridgeAPI
   class Client
     module LiveCourseEnrollment
-
       def get_all_live_course_enrollments(live_course, params = {})
         get("#{API_PATH}#{AUTHOR_PATH}/live_courses/#{live_course}/learners", params)
       end
-
     end
   end
 end

data/lib/bridge_api/client/manager.rb

@@ -1,7 +1,6 @@
 module BridgeAPI
   class Client
     module Manager
-
       def get_all_managers(params = {})
         get("#{API_PATH}#{AUTHOR_PATH}#{MANAGER_PATH}", params)
       end
@@ -10,11 +9,10 @@ module BridgeAPI
         path = "#{API_PATH}#{AUTHOR_PATH}#{MANAGER_PATH}/#{manager_id}/direct_reports"
         RESULT_MAPPING[path] = {
           primary: 'direct_reports',
-          meta: ['manager_id', 'direct_reports_count']
+          meta: %w[manager_id direct_reports_count]
         }
         get(path, params)
       end
-
     end
   end
 end