teamsnap_rb 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f9511231be3d578db265dfe57fef9b8144fba8f
-  data.tar.gz: 75edb7b7469b24e1e58211e2489a45aba6039317
+  metadata.gz: 2c81581a206de0d99dea75777830a764ba63b965
+  data.tar.gz: 284dc197b286c7bfa8041b5810332fe5717ccfc0
 SHA512:
-  metadata.gz: bcecd865a782c7f3925cea7ffc0ac533476e7f545727a434d540c5b467663a4df3feebfcdf92c52a4de947299cf960b939b976d6b917788e9eaac4d035c96cb1
-  data.tar.gz: 889f6cd95ee3257a8164787852bf63e36f19d2ebf07e6e75a98513ad041e7dd091bb536da13fa2dd8481904cd00fabb30481801c38b914c91902d20c20952477
+  metadata.gz: cf8b9e6b81e6fc05ffaa5270d9a5bc6b0ae32cd98106abe1e4af8029e9327111f59588acc007967343636c19e8d5636624058e4f39cf016101e8f31bed3e68dd
+  data.tar.gz: 9bd33d443efa7a176dda48c92227f3a8cf60c71292e9d54b7c0a1347f3e93348f7decb54ccf4f5f9d628524ea7b24838fc2598ff21e4538255195e535beea3e1

data/README.md

@@ -29,6 +29,18 @@ _Note: You'll need an OAuth2 Token from TeamSnap. Checkout our API docs
 => "Andrew"
 ```
 
+## Backup Cache
+
+By default when calling TeamSnap.init(...), there is a backup cache of the API root response used
+to setup all relevant classes. This is primarily used so CI testing and deploy jobs do not have to 
+connect to the API to complete.
+
+This creates a .teamsnap\_rb file in your ./tmp directory (./tmp/.teamsnap_rb). If you would like to turn this functionality
+off, just set ```:backup_cache => false``` in your init options. Alternatively, you can set the location
+of the backup by passing a string location of where to store the file. e.g.
+```:backup_cache => "./another/location/.teamsnap_rb_file"```
+
+
 ## Todo
 
 - Literate style docs?

data/lib/teamsnap/version.rb

@@ -1,3 +1,3 @@
 module TeamSnap
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/teamsnap.rb

@@ -104,6 +104,11 @@ module TeamSnap
         )
       end
 
+      opts[:backup_cache] = opts.fetch(:backup_cache) { true }
+      if opts[:backup_cache]
+        opts[:backup_cache_file] = TeamSnap.backup_file_for(opts[:backup_cache])
+      end
+
       self.client = Faraday.new(
         :url => opts.fetch(:url),
         :parallel_manager => Typhoeus::Hydra.new
@@ -116,7 +121,7 @@ module TeamSnap
         c.adapter :typhoeus
       end
 
-      collection = TeamSnap.run(:get, "/")
+      collection = TeamSnap.run(:get, "/", {}, opts)
 
       classes = []
       client.in_parallel do
@@ -131,18 +136,45 @@ module TeamSnap
       apply_endpoints(self, collection) && true
     end
 
-    def run(via, href, args = {})
+    def run(via, href, args = {}, opts = {})
       resp = client.send(via, href, args)
 
       if resp.status == 200
-        Oj.load(resp.body)
-          .fetch(:collection)
+        collection = Oj.load(resp.body).fetch(:collection)
+        TeamSnap.write_backup_file(opts[:backup_cache_file], collection)
+        collection
       else
-        error_message = parse_error(resp)
-        raise TeamSnap::Error.new(error_message)
+        if TeamSnap.backup_file_exists?(opts[:backup_cache_file])
+          warn("Connection to API failed.. using backup cache file to initialize endpoints")
+          Oj.load(IO.read(opts[:backup_cache_file]))
+        else
+          error_message = parse_error(resp)
+          raise TeamSnap::Error.new(error_message)
+        end
+      end
+    end
+
+    def backup_file_for(backup_cache)
+      backup_cache == true ? "./tmp/.teamsnap_rb" : backup_cache
+    end
+
+    def write_backup_file(file_location, collection)
+      return unless file_location
+      dir_location = File.dirname(file_location)
+      if Dir.exist?(dir_location)
+        File.open(file_location, "w+") { |f| f.write Oj.dump(collection) }
+      else
+        warn(
+          "WARNING: Directory '#{dir_location}' does not exist. " +
+          "Backup cache functionality will not work until this is resolved."
+        )
       end
     end
 
+    def backup_file_exists?(backup_cache_file)
+      !!backup_cache_file && File.exist?(backup_cache_file)
+    end
+
     def parse_error(resp)
       Oj.load(resp.body)
         .fetch(:collection)

data/spec/teamsnap_spec.rb

@@ -6,7 +6,8 @@ RSpec.describe "teamsnap_rb", :vcr => true do
     VCR.use_cassette("apiv3-init") do
       TeamSnap.init(
         :url => "http://localhost:3000",
-        :token => "1-classic-dont_tell_the_cops"
+        :token => "1-classic-dont_tell_the_cops",
+        :backup_cache => false
       )
     end
   end
@@ -161,4 +162,71 @@ RSpec.describe "teamsnap_rb", :vcr => true do
       end
     end
   end
+
+  context "supports using a backup file on init for when API cannot be reached" do
+    context ".backup_file_for" do
+      let(:default_file_location) { "./tmp/.teamsnap_rb" }
+
+      it "responds with the given file location if provided" do
+        file_location = "./some_dir/some_file.testing"
+        expect(TeamSnap.backup_file_for(file_location)).to eq(file_location)
+      end
+
+      it "responds with the default file location if set to true" do
+        expect(TeamSnap.backup_file_for(true)).to eq(default_file_location)
+      end
+    end
+
+    context ".write_backup_file" do
+      let(:collection) { {:one => 1} }
+
+      context "when the given directory exists" do
+        let(:test_file_location) { "./tmp/.teamsnap_rb" }
+        let(:file_contents) { Oj.dump(collection) }
+
+        it "returns the number of characters written to the file" do
+          expect(TeamSnap.write_backup_file(test_file_location, collection)).to eq(file_contents.length)
+        end
+
+        it "writes the file inside the directory provided" do
+          expect(File).to receive(:open).with(test_file_location, "w+")
+          TeamSnap.write_backup_file(test_file_location, collection)
+        end
+
+        it "writes the file with the correct information" do
+          TeamSnap.write_backup_file(test_file_location, collection)
+          file_contents = Oj.load(IO.read(test_file_location))
+          expect(file_contents).to eq(collection)
+        end
+      end
+
+      context "when the given directory does NOT exist" do
+        let(:test_file_location) { "./directory_doesnt_exist/file" }
+        let(:test_dir_location) { File.dirname(test_file_location) }
+        let(:warning_message) {
+          "WARNING: Directory '#{test_dir_location}' does not exist. " +
+          "Backup cache functionality will not work until this is resolved."
+        }
+
+        it "issues a warning that the directory does not exist" do
+          expect(TeamSnap).to receive(:warn).with(warning_message)
+          TeamSnap.write_backup_file(test_file_location, collection)
+        end
+      end
+    end
+
+    context ".backup_file_exists?" do
+      it "returns false if backup_cache_file is NOT set" do
+        expect(TeamSnap.backup_file_exists?(nil)).to eq(false)
+      end
+
+      it "returns false if the file does NOT exist" do
+        expect(TeamSnap.backup_file_exists?("./some_file_that_does_not_exist")).to eq(false)
+      end
+
+      it "returns true is the file exists" do
+        expect(TeamSnap.backup_file_exists?("./Gemfile")).to eq(true)
+      end
+    end
+  end
 end

data/tmp/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teamsnap_rb
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Shane Emmons
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -174,6 +174,7 @@ files:
 - spec/spec_helper.rb
 - spec/teamsnap_spec.rb
 - teamsnap_rb.gemspec
+- tmp/.gitignore
 homepage: http://developer.teamsnap.com/
 licenses:
 - MIT
@@ -194,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A gem to interact with TeamSnap's API