bridge_blueprint 0.0.05 → 0.0.06

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e40854d5a34a871c4f3b9384ea89c36357c67d8
-  data.tar.gz: a30a814a45d27d9a3bc531139e076f2f0f4aa61e
+  metadata.gz: d8a68f02757c7f40a292efbc3881a81da73d0700
+  data.tar.gz: 7ac7101287000b7426ea73bb80ddc2a4c069db33
 SHA512:
-  metadata.gz: f8705c4f29857b0b0b4911081f0c2d59315d1ff208a6de31fcc056beac681cc9666c64669459168b35a91c549b009ee557d74823fafde8cc879a1241a481ffe6
-  data.tar.gz: c4b3c49049a61d6dc5155c784bca1ba010159ac849f291196492f2ed67e4ddcca9ddb9714f1228887336634459282e7c5bb78468043562a0834b6f7076e7cf50
+  metadata.gz: 0c4496431f46b3182cbe48da9531f5a95645ae692a54fc22b3fbdea074cebafba82562ab0f00dc2f1c92a360f487fd68d1885215652e85261f970065811d9d93
+  data.tar.gz: 203ea3230d0dd1a513afca9624caa8fa94e26035356645439b57209a610b1b7b6d332ec3833917e0d0e136e2ca74fe75b52fbf9febb919d7b5d39ec698df7eff

data/.gitignore

@@ -2,5 +2,5 @@
 .idea/
 bridge_api.iml
 .byebug.*
-
+.byebug_history
 .*.gem

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bridge_blueprint (0.0.05)
+    bridge_blueprint (0.0.06)
       bridge_api (~> 0.1.16)
       open_uri_redirections (~> 0.2.1)
       rubyzip (~> 1.2.1)
@@ -9,14 +9,14 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    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)
       public_suffix (~> 2.0, >= 2.0.2)
-    bridge_api (0.1.16)
+    bridge_api (0.1.19)
       faraday (~> 0.9.0)
       faraday_middleware (~> 0.9.0)
       footrest (>= 0.5.1)
@@ -35,11 +35,11 @@ GEM
       faraday (~> 0.9.0)
       link_header (>= 0.0.7)
     hashdiff (0.3.4)
-    i18n (0.9.1)
+    i18n (1.0.0)
       concurrent-ruby (~> 1.0)
     link_header (0.0.8)
     method_source (0.8.2)
-    minitest (5.11.1)
+    minitest (5.11.3)
     multipart-post (2.0.0)
     open_uri_redirections (0.2.1)
     pry (0.10.4)
@@ -68,7 +68,7 @@ GEM
     slop (3.6.0)
     thread_safe (0.3.6)
     tilt (1.4.1)
-    tzinfo (1.2.4)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
     webmock (2.3.2)
       addressable (>= 2.3.6)
@@ -90,4 +90,4 @@ DEPENDENCIES
   webmock (~> 2.3.1)
 
 BUNDLED WITH
-   1.14.6
+   1.16.1

data/bridge_blueprint.gemspec

@@ -1,33 +1,35 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'bridge_blueprint/version'
 
 Gem::Specification.new do |gem|
-  gem.authors =       ["Jay Shaffer"]
-  gem.email =         ["jshaffer@instructure.com"]
-  gem.description =   %q{Tools for consuming bridge data dumps}
-  gem.summary =       %q{Bridge Blueprint}
-  gem.homepage =      "https://getbridge.com"
+  gem.authors =       ['Jay Shaffer']
+  gem.email =         ['jshaffer@instructure.com']
+  gem.description =   'Tools for consuming bridge data dumps'
+  gem.summary =       'Bridge Blueprint'
+  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_blueprint"
-  gem.require_paths = ["lib"]
+  gem.files += Dir.glob('lib/**/*.rb')
+  gem.files += Dir.glob('spec/**/*')
+  gem.test_files    = Dir.glob('spec/**/*')
+  gem.name          = 'bridge_blueprint'
+  gem.require_paths = ['lib']
   gem.version       = BridgeBlueprint::VERSION
 
   gem.add_runtime_dependency 'bridge_api', '~> 0.1.16'
   gem.add_runtime_dependency 'open_uri_redirections', '~> 0.2.1'
   gem.add_runtime_dependency 'rubyzip', '~> 1.2.1'
 
-  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', '~>2.3.1'
+  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', '~>2.3.1'
 end

data/lib/bridge_blueprint/constants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeBlueprint
   class Constants
     STATUS_FAILED = 'failed'

data/lib/bridge_blueprint/data_dump.rb

@@ -1,16 +1,15 @@
+# frozen_string_literal: true
+
 require 'csv'
 require 'zip'
 
 module BridgeBlueprint
   class DataDump
-
     @path = nil
 
     def initialize(path)
       @path = path
-      unless File.exists?(path)
-        raise "File not found #{path}"
-      end
+      raise "File not found #{path}" unless File.exist?(path)
     end
 
     def each_row(name)
@@ -29,11 +28,10 @@ module BridgeBlueprint
         file = nil
         Zip::File.open(@path) do |zip_file|
           zip_file.each do |entry|
-            if "#{name.to_s}" == entry.name
-              path = "#{dir}/#{entry.name}"
-              file = entry.extract(path)
-              break
-            end
+            next unless name.to_s == entry.name
+            path = "#{dir}/#{entry.name}"
+            file = entry.extract(path)
+            break
           end
         end
         if file

data/lib/bridge_blueprint/remote_data.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 require 'open-uri'
 require 'open_uri_redirections'
 require 'net/http'
 require 'uri'
 require 'base64'
-require "bridge_api"
+require 'bridge_api'
 
 module BridgeBlueprint
-
   class RemoteData
-
     USERS_CSV_NAME = 'users.csv'
     CUSTOM_FIELD_CSV_NAME = 'custom_fields.csv'
     GRANTS_CSV_NAME = 'grants.csv'
 
+    attr_accessor :client
+
     @base_url = nil
     @auth_header = nil
     @file_url = nil
@@ -22,17 +24,28 @@ module BridgeBlueprint
 
     def initialize(base_url, key, secret)
       @base_url = base_url
-      @auth_header = 'Basic ' +  Base64.strict_encode64("#{key}:#{secret}")
+      @auth_header = 'Basic ' + Base64.strict_encode64("#{key}:#{secret}")
       @client = BridgeAPI::Client.new(prefix: base_url, api_key: key, api_secret: secret)
     end
 
     def start_data_report
-       @client.create_data_dump
+      raw_dumps = get_dumps
+      dumps = raw_dumps.members
+      unless dumps.empty?
+        dump = dumps.first
+        case dump['status']
+        when 'pending'
+          return
+        when 'complete'
+          return if Time.parse(dump['date']) > Time.now - 300
+          end
+      end
+      @client.create_data_dump
     end
 
     def status
       dumps = get_dumps
-      if dumps.members.size > 0
+      if !dumps.members.empty?
         return get_dumps.first['status']
       else
         return BridgeBlueprint::Constants::STATUS_NOT_FOUND
@@ -44,12 +57,12 @@ module BridgeBlueprint
       uri = URI.parse(@base_url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.read_timeout = 300
-      http.use_ssl = (uri.scheme == "https")
+      http.use_ssl = (uri.scheme == 'https')
       req = Net::HTTP::Get.new("#{@base_url}/api/admin/data_dumps/download")
-      req.add_field("Authorization", @auth_header)
+      req.add_field('Authorization', @auth_header)
       res = http.request(req)
       redirect_url = res['location']
-      File.open(@file_path, 'w') do |file|
+      File.open(@file_path, 'w') do |_file|
         IO.copy_stream(open(redirect_url), @file_path)
       end
     end
@@ -62,11 +75,10 @@ module BridgeBlueprint
 
     def get_headers
       {
-          'Authorization'=> @auth_header,
-          'Content-Type'=> 'application/json',
-          'Accept'=> 'application/json'
+        'Authorization' => @auth_header,
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json'
       }
     end
   end
-
 end

data/lib/bridge_blueprint/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BridgeBlueprint
-  VERSION = '0.0.05' unless defined?(BridgeBlueprint::VERSION)
+  VERSION = '0.0.06' unless defined?(BridgeBlueprint::VERSION)
 end

data/lib/bridge_blueprint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bridge_blueprint/version'
 require 'bridge_blueprint/data_dump'
 require 'bridge_blueprint/constants'

data/spec/bridge_blueprint/data_dump_spec.rb

@@ -1,15 +1,16 @@
-require "test_helper"
+# frozen_string_literal: true
+
+require 'test_helper'
 require 'zip'
 
 describe BridgeBlueprint::DataDump do
-
   before(:each) do
     dir = Dir.mktmpdir
     zip_folder_path = "#{File.dirname(__FILE__)}/../fixtures/bridge_zip"
     input_filenames = [
-        'users.csv',
-        'custom_fields.csv'
-      ]
+      'users.csv',
+      'custom_fields.csv'
+    ]
 
     @zipfile_name = "#{dir}/dump.zip"
 
@@ -24,11 +25,11 @@ describe BridgeBlueprint::DataDump do
     it 'should parse a bridge data dump file' do
       file = BridgeBlueprint::DataDump.new(@zipfile_name)
       user_count = 0
-      file.each_row('users') do |user|
+      file.each_row('users') do |_user|
         user_count += 1
       end
       custom_field_count = 0
-      file.each_row('custom_fields') do |custom_field|
+      file.each_row('custom_fields') do |_custom_field|
         custom_field_count += 1
       end
       expect(user_count).to(eq(2))

data/spec/bridge_blueprint/remote_data_spec.rb

@@ -1,15 +1,16 @@
-require "test_helper"
+# frozen_string_literal: true
+
+require 'test_helper'
 require 'zip'
 
 describe BridgeBlueprint::RemoteData do
-
   before(:each) do
     @dir = Dir.mktmpdir
     zip_folder_path = "#{File.dirname(__FILE__)}/../fixtures/bridge_zip"
     input_filenames = [
-        'users.csv',
-        'custom_fields.csv'
-      ]
+      'users.csv',
+      'custom_fields.csv'
+    ]
 
     @zipfile_name = "#{@dir}/dump.zip"
 
@@ -19,14 +20,35 @@ describe BridgeBlueprint::RemoteData do
       end
     end
 
-    stub_request(:get, "https://example.com/fake-file-url").
-       with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
-       to_return(:status => 200, :body => lambda{|request| File.open(@zipfile_name)}, :headers => {})
+    stub_request(:get, 'https://example.com/fake-file-url')
+      .with(headers: { 'Accept' => '*/*', 'User-Agent' => 'Ruby' })
+      .to_return(status: 200, body: ->(_request) { File.open(@zipfile_name) }, headers: {})
   end
 
   describe 'completed' do
     it 'should start a data dump' do
       data = BridgeBlueprint::RemoteData.new('https://example.com', 'key', 'secret')
+      expect(data.client).to receive(:create_data_dump)
+      data.start_data_report
+    end
+  end
+
+  describe 'completed' do
+    it 'should not start a data dump if already pending' do
+      data = BridgeBlueprint::RemoteData.new('https://pending.com', 'key', 'secret')
+      expect(data.client).not_to receive(:create_data_dump)
+      data.start_data_report
+    end
+
+    it 'should not start a data dump if one has already completed in the past 5 minutes' do
+      data = BridgeBlueprint::RemoteData.new('https://recent.com', 'key', 'secret')
+      expect(data.client).not_to receive(:create_data_dump)
+      data.start_data_report
+    end
+
+    it 'should start a data dump if one hasnt already completed in the past 5 minutes' do
+      data = BridgeBlueprint::RemoteData.new('https://notrecent.com', 'key', 'secret')
+      expect(data.client).to receive(:create_data_dump)
       data.start_data_report
     end
   end
@@ -43,8 +65,7 @@ describe BridgeBlueprint::RemoteData do
       data = BridgeBlueprint::RemoteData.new('https://example.com', 'key', 'secret')
       dir = Dir.mktmpdir
       data.store_file("#{@dir}/data_dump.csv")
-      expect(File.exists?("#{@dir}/data_dump.csv")).to(eq(true))
+      expect(File.exist?("#{@dir}/data_dump.csv")).to(eq(true))
     end
   end
-
 end

data/spec/fixtures/data_dumps_pending.json

@@ -0,0 +1,9 @@
+{
+  "meta": {},
+  "data_dumps": [
+    {
+      "status": "pending",
+      "date": "2015-11-12T19:03:37Z"
+    }
+  ]
+}

data/spec/support/fake_bridge.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'sinatra/base'
 require 'tilt'
 
 class FakeBridge < Sinatra::Base
-
   ## Course Templates
 
   get %r{/api/author/course_templates$} do
@@ -84,7 +85,7 @@ class FakeBridge < Sinatra::Base
     get_json_data 200, 'enrollment.json'
   end
 
-  #Custom Fields
+  # Custom Fields
 
   get %r{/api/author/custom_fields} do
     get_json_data 200, 'custom_fields.json'
@@ -109,7 +110,20 @@ class FakeBridge < Sinatra::Base
   # Data Dumps
 
   get %r{/api/admin/data_dumps$} do
-    get_json_data 200, 'data_dumps.json'
+    host = URI.parse(url).host
+    if host == 'pending.com'
+      get_json_data 200, 'data_dumps_pending.json'
+    elsif host == 'notrecent.com'
+      data = JSON.parse(fixture('data_dumps.json').read)
+      data['data_dumps'][0]['date'] = (Time.now - 310).to_s
+      custom_response(data.to_json)
+    elsif host == 'recent.com'
+      data = JSON.parse(fixture('data_dumps.json').read)
+      data['data_dumps'][0]['date'] = (Time.now - 290).to_s
+      custom_response(data.to_json)
+    else
+      get_json_data 200, 'data_dumps.json'
+    end
   end
 
   post %r{/api/admin/data_dumps$} do
@@ -119,19 +133,24 @@ class FakeBridge < Sinatra::Base
   get %r{/api/admin/data_dumps/download.*} do
     content_type :json
     status 200
-    headers[:location] = "https://example.com/fake-file-url"
+    headers[:location] = 'https://example.com/fake-file-url'
   end
 
   private
 
+  def custom_response(data)
+    content_type :json
+    status 200
+    data
+  end
+
   def get_json_data(response_code, file_name)
     content_type :json
     status response_code
-    unless file_name.nil?
-      File.open(File.dirname(__FILE__) + '/../fixtures/' + file_name).read
-    else
+    if file_name.nil?
       {}
+    else
+      File.open(File.dirname(__FILE__) + '/../fixtures/' + file_name).read
     end
   end
-
 end

data/spec/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bridge_blueprint'
 require 'rspec'
 require 'webmock/rspec'
@@ -5,7 +7,7 @@ require 'json'
 require 'pry'
 
 RSpec.configure do |config|
-  Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+  Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
 
   config.before(:each) do
     WebMock.disable_net_connect!
@@ -13,7 +15,6 @@ RSpec.configure do |config|
   end
 end
 
-
 def fixture(*file)
-  File.new(File.join(File.expand_path("../fixtures", __FILE__), *file))
+  File.new(File.join(File.expand_path('fixtures', __dir__), *file))
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridge_blueprint
 version: !ruby/object:Gem::Version
-  version: 0.0.05
+  version: 0.0.06
 platform: ruby
 authors:
 - Jay Shaffer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-15 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridge_api
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.1
-- !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
@@ -87,35 +73,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: 8.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: 8.2.2
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -129,25 +115,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tilt
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.4
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.4
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -163,19 +143,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.4
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 8.2.2
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.4
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 8.2.2
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
 description: Tools for consuming bridge data dumps
 email:
 - jshaffer@instructure.com
@@ -199,6 +199,7 @@ files:
 - spec/fixtures/bridge_zip/custom_fields.csv
 - spec/fixtures/bridge_zip/users.csv
 - spec/fixtures/data_dumps.json
+- spec/fixtures/data_dumps_pending.json
 - spec/support/fake_bridge.rb
 - spec/test_helper.rb
 homepage: https://getbridge.com
@@ -221,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Bridge Blueprint
@@ -231,6 +232,6 @@ test_files:
 - spec/fixtures/bridge_zip/custom_fields.csv
 - spec/fixtures/bridge_zip/users.csv
 - spec/fixtures/data_dumps.json
+- spec/fixtures/data_dumps_pending.json
 - spec/support/fake_bridge.rb
 - spec/test_helper.rb
-has_rdoc: