gisture 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03e7d1d1abd295d696f903a9017625ef7f4523f0
-  data.tar.gz: 4e7d8c8ddb6570ff3b8c1f366f791701e0640bdc
+  metadata.gz: 3bdea019b5a0fbb8b6ae761da872e410309450ed
+  data.tar.gz: a2e957a0da22cfda85e7b10376fe0895a90ca1c2
 SHA512:
-  metadata.gz: f1e213b93a08f3c3a552e28e8fb9900a7f504c5bdd1de7265901a8480dd8d869a85f2f6132bcf42cdd1ec88a85013c69d50da5f0fa91bc311a7f30e579990dc5
-  data.tar.gz: 8f9244489caba893887c4ecac9352b881e75f1b241c9a7c858cf3d41e8ad0a439dbf926d2dc3eaf7d8352e111b1148c7ae22549e1c2bf443432d796524cba5ea
+  metadata.gz: 69d3b4ec1d28e33326d7b79452bc90b9aea5011f237f7154e89209ac54be2d565284c9076424b34cf4907249988cdcf8fb900eb25e444a7feb7d48c37f52c2e4
+  data.tar.gz: 1038a6294c4eeffb1dfc24c6f2ba3528f2b974050a39681fda8d4654675f5b32c9bc103a40715ca0fd19586883ab1d34d6668724598c5e32e6ddb14fa5ac0b99

data/lib/gisture/errors.rb

@@ -0,0 +1,7 @@
+module Gisture
+  class OwnerBlacklisted < StandardError
+    def initialize(owner)
+      super("Gists from '#{owner}' have not been whitelisted for execution. Add them to the 'owners' configuration option.")
+    end
+  end
+end

data/lib/gisture/file.rb

@@ -2,7 +2,13 @@ require 'tempfile'
 
 module Gisture
   class File
-    attr_reader :file, :basename
+    attr_reader :file, :basename, :strategy
+
+    STRATEGIES = [:eval, :load, :require]
+
+    def run!(&block)
+      send "#{strategy}!".to_sym, &block
+    end
 
     def require!(&block)
       required = require tempfile.path
@@ -17,17 +23,22 @@ module Gisture
     end
 
     def eval!(&block)
-      clean_room = Evaluator.new(content)
+      clean_room = Evaluator.new(file.content)
       clean_room.instance_eval &block if block_given?
       clean_room
     end
 
+    def strategy=(strat)
+      raise ArgumentError, "Invalid strategy '#{strat}'. Must be one of #{STRATEGIES.join(', ')}" unless STRATEGIES.include?(strat.to_sym)
+      @strategy = strat.to_sym
+    end
+
     def tempfile
       @tempfile ||= begin
-        file = Tempfile.new([basename, filename, ::File.extname(filename)].compact, Gisture.configuration.tmpdir)
-        file.write(content)
-        file.close
-        file
+        tmpfile = Tempfile.new([basename, file.filename, ::File.extname(file.filename)].compact, Gisture.configuration.tmpdir)
+        tmpfile.write(file.content)
+        tmpfile.close
+        tmpfile
       end
     end
 
@@ -47,9 +58,10 @@ module Gisture
 
     protected
 
-    def initialize(file, basename=nil)
+    def initialize(file, basename: nil, strategy: nil)
       @file = file
       @basename = basename
+      self.strategy = strategy || Gisture.configuration.strategy
     end
   end
 end

data/lib/gisture/gist.rb

@@ -36,22 +36,23 @@ module Gisture
     def gist
       @gist ||= begin
         if @version.nil?
-          github.gists.get(gist_id)
+          g = github.gists.get(gist_id)
         else
-          github.gists.version(gist_id, @version)
+          g = github.gists.version(gist_id, @version)
         end
+        raise OwnerBlacklisted.new(g.owner.login) unless Gisture.configuration.whitelisted?(g.owner.login)
+        g
       end
     end
 
     def file
       return @file unless @file.nil?
 
-      if gist.files.count > 1
-        raise ArgumentError, "You must specify a filename if your gist contains more than one file" if filename.nil?
-        @file = Gisture::File.new(gist.files[filename], gist_id)
+      if gist.files.count > 1 && !filename.nil?
+        @file = Gisture::File.new(gist.files[filename], basename: gist_id, strategy: strategy)
         raise ArgumentError, "The filename '#{filename}' was not found in the list of files for the gist '#{gist_id}'" if @file.nil?
       else
-        @file = Gisture::File.new(gist.files.first[1], gist_id)
+        @file = Gisture::File.new(gist.files.first[1], basename: gist_id, strategy: strategy)
       end
 
       @file

data/lib/gisture/repo.rb

@@ -0,0 +1,62 @@
+module Gisture
+  class Repo
+    attr_reader :owner, :project
+    REPO_URL_REGEX = /\A((http[s]?:\/\/)?github\.com\/)?([a-z0-9_\-\.]*)\/([a-z0-9_\-\.]*)\/?\Z/i
+    FILE_URL_REGEX = /\A((http[s]?:\/\/)?github\.com\/)?(([a-z0-9_\-\.]*)\/([a-z0-9_\-\.]*))(\/[a-z0-9_\-\.\/]+)\Z/i
+
+    class << self
+      def file(path, strategy: nil)
+        repo, file = parse_file_url(path)
+        new(repo).file(file, strategy: strategy)
+      end
+
+      def run!(path, strategy: nil, &block)
+        file(path, strategy: strategy).run!(&block)
+      end
+
+      def parse_repo_url(repo_url)
+        matched = repo_url.match(REPO_URL_REGEX)
+        raise ArgumentError, "Invalid argument: '#{repo_url}' is not a valid repo URL." if matched.nil?
+        [matched[3], matched[4]]
+      end
+
+      def parse_file_url(file_url)
+        matched = file_url.match(FILE_URL_REGEX)
+        raise ArgumentError, "Invalid argument: '#{file_url}' is not a valid file path." if matched.nil?
+        [matched[3], matched[6]]
+      end
+    end
+
+    def github
+      @github ||= begin
+        Github.new(github_config)
+      end
+    end
+
+    def repo
+      @repo ||= github.repos.get user: owner, repo: project
+    end
+
+    def file(path, strategy: nil)
+      file = github.repos.contents.get(user: owner, repo: project, path: path).body
+      file['filename'] = ::File.basename(file['path'])
+      file['content'] = Base64.decode64(file['content'])
+      Gisture::File.new(file, basename: "#{owner}-#{project}", strategy: strategy)
+    end
+
+    def run!(path, strategy: nil, &block)
+      file(path, strategy: strategy).run!(&block)
+    end
+
+    protected
+
+    def initialize(repo)
+      @owner, @project = self.class.parse_repo_url(repo)
+      raise OwnerBlacklisted.new(owner) unless Gisture.configuration.whitelisted?(owner)
+    end
+
+    def github_config
+      github_config = Hash[Gisture::GITHUB_CONFIG_OPTS.map { |key| [key, Gisture.configuration.send(key)] }]
+    end
+  end
+end

data/lib/gisture/version.rb

@@ -1,3 +1,3 @@
 module Gisture
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/lib/gisture.rb

@@ -2,9 +2,11 @@ require 'canfig'
 require 'github_api'
 require 'gisture/github_api/client/gists'
 require 'gisture/version'
+require 'gisture/errors'
 require 'gisture/evaluator'
 require 'gisture/file'
 require 'gisture/gist'
+require 'gisture/repo'
 require 'gisture/railtie' if defined?(Rails)
 
 module Gisture
@@ -23,13 +25,30 @@ module Gisture
 
     config.strategy       = :eval       # default execution strategy
     config.tmpdir         = Dir.tmpdir  # location to store gist tempfiles
+    config.owners         = nil         # only allow gists/repos/etc. from whitelisted owners (str/sym/arr)
+
+    def whitelisted?(owner)
+      owners.nil? || owners.empty? || [owners].flatten.map(&:to_s).include?(owner)
+    end
   end
 
   def self.new(gist, strategy: nil, filename: nil, version: nil)
     Gisture::Gist.new(gist, strategy: strategy, filename: filename, version: version)
   end
 
+  def self.gist(gist, strategy: nil, filename: nil, version: nil)
+    new(gist, strategy, filename, version)
+  end
+
   def self.run(gist, strategy: nil, filename: nil, version: nil, &block)
     new(gist, strategy, filename, version).run!(&block)
   end
+
+  def self.repo(repo)
+    Gisture::Repo.new(repo)
+  end
+
+  def self.file(path, strategy: nil)
+    Gisture::Repo.file(path, strategy: strategy)
+  end
 end

data/spec/gisture/file_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
-RSpec.describe Gisture::Gist do
-  subject { Gisture::File.new(Gisture::Gist.new(TEST_GIST_ID).gist.files.first[1], TEST_GIST_ID) }
+RSpec.describe Gisture::File do
+  subject { Gisture::File.new(Gisture::Gist.new(TEST_GIST_ID).gist.files.first[1], basename: TEST_GIST_ID) }
 
   it "delegates missing methods to the file hash" do
     expect(subject.respond_to?(:content)).to be_true

data/spec/gisture/gist_spec.rb

@@ -63,6 +63,24 @@ RSpec.describe Gisture::Gist do
     end
   end
 
+  context "when not passing a strategy" do
+    it "uses the default configured strategy" do
+      begin
+        Gisture.configure do |config|
+          config.strategy = :load
+        end
+
+        expect(Gisture::Gist.new(TEST_GIST_ID).strategy).to eql(:load)
+      rescue => e
+        raise e
+      ensure
+        Gisture.configure do |config|
+          config.strategy = :eval
+        end
+      end
+    end
+  end
+
   describe "#github" do
     subject { Gisture::Gist.new(TEST_GIST_ID) }
 
@@ -77,6 +95,44 @@ RSpec.describe Gisture::Gist do
     it "is the gist that was requested" do
       expect(subject.gist.id).to eql(TEST_GIST_ID)
     end
+
+    context "when whitelisted owners have been configured" do
+      context "and the gist owner is whitelisted" do
+        it "does not raise an error" do
+          begin
+            Gisture.configure do |config|
+              config.owners = [:markrebec]
+            end
+
+            expect { Gisture::Gist.new(TEST_GIST_ID).gist }.to_not raise_exception
+          rescue => e
+            raise e
+          ensure
+            Gisture.configure do |config|
+              config.owners = nil
+            end
+          end
+        end
+      end
+
+      context "and the gist owner is not whitelisted" do
+        it "raises a OwnerBlacklisted error" do
+          begin
+            Gisture.configure do |config|
+              config.owners = [:tester]
+            end
+
+            expect { Gisture::Gist.new(TEST_GIST_ID).gist }.to raise_exception(Gisture::OwnerBlacklisted)
+          rescue => e
+            raise e
+          ensure
+            Gisture.configure do |config|
+              config.owners = nil
+            end
+          end
+        end
+      end
+    end
   end
 
   describe "#file" do
@@ -102,8 +158,8 @@ RSpec.describe Gisture::Gist do
       context "and no filename is present" do
         subject { Gisture::Gist.new(MULTI_FILE_TEST_GIST_ID) }
 
-        it "raises an ArgumentError" do
-          expect { subject.file }.to raise_exception(ArgumentError)
+        it "uses the first file in the gist" do
+          expect(subject.file.filename).to eql(MULTI_FILE_TEST_GIST_FILENAMES.first)
         end
       end
     end

data/spec/gisture/repo_spec.rb

@@ -0,0 +1,94 @@
+require "spec_helper"
+
+RSpec.describe Gisture::Repo do
+  context "when passed a valid repo slug" do
+    subject { Gisture::Repo.new('markrebec/gisture') }
+
+    it "sets the owner and project correctly" do
+    end
+  end
+
+  context "when passed a valid repo URL" do
+    subject { Gisture::Repo.new('https://github.com/markrebec/gisture') }
+
+    it "sets the owner and project correctly" do
+    end
+  end
+
+  context "when passed an invalid repo" do
+    it "raises an ArgumentError" do
+      expect { Gisture::Repo.new('foo') }.to raise_exception(ArgumentError)
+      expect { Gisture::Repo.new('markrebec/foo/bar') }.to raise_exception(ArgumentError)
+      expect { Gisture::Repo.new('http://github.com') }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context "when whitelisted owners have been configured" do
+    context "and the repo owner is whitelisted" do
+      it "does not raise an error" do
+        begin
+          Gisture.configure do |config|
+            config.owners = [:markrebec]
+          end
+
+          expect { Gisture::Repo.new('markrebec/gisture') }.to_not raise_exception
+        rescue => e
+          raise e
+        ensure
+          Gisture.configure do |config|
+            config.owners = nil
+          end
+        end
+      end
+    end
+
+    context "and the gist owner is not whitelisted" do
+      it "raises a OwnerBlacklisted error" do
+        begin
+          Gisture.configure do |config|
+            config.owners = [:tester]
+          end
+
+          expect { Gisture::Repo.new('markrebec/gisture') }.to raise_exception(Gisture::OwnerBlacklisted)
+        rescue => e
+          raise e
+        ensure
+          Gisture.configure do |config|
+            config.owners = nil
+          end
+        end
+      end
+    end
+  end
+
+  describe "#github" do
+    subject { Gisture::Repo.new('markrebec/gisture') }
+
+    it "is a github_api client object" do
+      expect(subject.github).to be_a(Github::Client)
+    end
+  end
+
+  # TODO stub out Github::Client::Repos
+  describe '#repo' do
+    context "when the repo doesn't exist" do
+    end
+  end
+
+  # TODO stub out Github::Client::Repos::Contents
+  describe '#file' do
+    context "when the repo doesn't exist" do
+    end
+
+    context "when the file doesn't exist" do
+    end
+  end
+
+  describe '.file' do
+    context "when the repo doesn't exist" do
+    end
+
+    context "when the file doesn't exist" do
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gisture
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: canfig
@@ -74,11 +74,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/gisture.rb
+- lib/gisture/errors.rb
 - lib/gisture/evaluator.rb
 - lib/gisture/file.rb
 - lib/gisture/gist.rb
 - lib/gisture/github_api/client/gists.rb
 - lib/gisture/railtie.rb
+- lib/gisture/repo.rb
 - lib/gisture/version.rb
 - lib/tasks/gisture.rake
 - spec/gists/called_class.rb
@@ -89,6 +91,7 @@ files:
 - spec/gisture/evaluator_spec.rb
 - spec/gisture/file_spec.rb
 - spec/gisture/gist_spec.rb
+- spec/gisture/repo_spec.rb
 - spec/gisture_spec.rb
 - spec/spec_helper.rb
 - spec/support/gists.rb
@@ -125,6 +128,7 @@ test_files:
 - spec/gisture/evaluator_spec.rb
 - spec/gisture/file_spec.rb
 - spec/gisture/gist_spec.rb
+- spec/gisture/repo_spec.rb
 - spec/gisture_spec.rb
 - spec/spec_helper.rb
 - spec/support/gists.rb