github-fs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1616fb6a15a1deb942a3a51dae8f2180a0cf8c6
+  data.tar.gz: ab0f6caf968fcd89b87187998dfe0ea2f009d3ba
+SHA512:
+  metadata.gz: db7346a7fdb1f91bf90ebad5f1748ea60ebac725e344430520a67ddbd9c85dd411d747c1baa70dac87bdc6b1bbc597b3cf3a9bbbae8694cf7681a68dfb8aab5d
+  data.tar.gz: 859d86b7b716cb2c372aa5e804e7d62a61716a8240db169afbfda400ed30e26325b2c2d8ff42e70d2ebba9095d728e64c2cc5553a2ea6f9400ee1123a8738da3

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+spec/credentials.yml
+githubfs-test/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github-fs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Architects.io, Inc. and Jonathan Soeder
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,13 @@
+# Github Filesystem 
+
+This is a ruby wrapper that intends to provide an easy `File`-esque
+wrapper round the Github API's contents endpoints.
+
+This will allow you to create, read, find, update, and delete files using a familiar API based off of ruby's own `File` and `Dir` classes.
+
+### TODO
+
+- [x] Implement File.open("path", "a+") mode
+- [x] Implement File.open("path", "a") mode
+- [x] Implement File.open("path", "w") mode
+- [x] Implement File.open("path", "w+") mode

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/github-fs.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github-fs/version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github-fs"
+  spec.version       = GHFS::VERSION
+  spec.authors       = ["Jonathan Soeder"]
+  spec.email         = ["jonathan.soeder@gmail.com"]
+  spec.summary       = %q{Work with the Github Contents API the way you would a normal file object}
+  spec.description   = %q{Creating, updating, deleting files on the github api using the same APIs as you would working with files your local file system.}
+  spec.homepage      = "https://github.com/architects/github-fs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency 'octokit'
+  spec.add_dependency 'rack'
+  spec.add_dependency 'activesupport', '> 3.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "> 3.0.0"
+  spec.add_development_dependency "pry"
+end

data/lib/github-fs.rb

@@ -0,0 +1,25 @@
+require 'pathname'
+require 'singleton'
+require 'yaml'
+require 'octokit'
+require 'github-fs/version'
+require 'github-fs/util'
+require 'github-fs/test_helpers'
+require 'github-fs/config'
+require 'github-fs/file'
+require 'github-fs/dir'
+require 'rack'
+require 'active_support/core_ext'
+
+module GHFS
+  NotFound = Class.new(Exception)
+  ReadOnly = Class.new(Exception)
+
+  def self.config
+    GHFS::Config.instance
+  end
+
+  def self.api
+    @api ||= Octokit::Client.new(access_token: config.github_access_token)
+  end
+end

data/lib/github-fs/config.rb

@@ -0,0 +1,38 @@
+module GHFS
+  class Config
+    include Singleton
+
+    def self.method_missing(meth, *args, &block)
+      if instance.respond_to?(meth)
+        instance.send(meth, *args, &block)
+      else
+        super
+      end
+    end
+
+    def branch= value
+      @branch = value
+    end
+
+    def branch
+      @branch || "master"
+    end
+
+    def github_access_token= value
+      @github_access_token = value
+    end
+
+    def github_access_token
+      @github_access_token || raise("Github access token is not set")
+    end
+
+    def repository= value
+      @repository = value
+    end
+
+    def repository
+      @repository || raise("Github repository is not set")
+    end
+
+  end
+end

data/lib/github-fs/dir.rb

@@ -0,0 +1,10 @@
+module GHFS
+  class Dir
+    class << self
+      def [](path)
+        # TODO
+        # Implement
+      end
+    end
+  end
+end

data/lib/github-fs/file.rb

@@ -0,0 +1,132 @@
+module GHFS
+  class File
+    class << self
+      def open(path, mode=nil, options={}, &block)
+        file = new(path, mode, options)
+        yield(file) if block_given?
+        file
+      end
+    end
+
+    attr_reader :path, :mode, :options, :repository, :branch
+
+    def initialize(path, mode="w", options={})
+      @path       = path
+      @mode       = mode || "w"
+      @options    = options
+      @repository = options.fetch(:repository) { GHFS.config.repository }
+      @branch     = options.fetch(:branch) { GHFS.config.branch }
+      @contents   = options[:contents] || options[:content]
+    end
+
+    def contents
+      @contents || read
+    end
+
+    def read
+      @contents ||= begin
+                      encoded = api_entity.content rescue nil
+
+                      if encoded.to_s.length > 0
+                        Base64.decode64(encoded)
+                      end
+                    end
+    end
+
+    def delete
+      raise GHFS::NotFound if new_file?
+      raise GHFS::ReadOnly if read_only?
+      GHFS.api.delete_contents(repo, path, "Deleting #{ path }", branch: branch)
+    end
+
+    def unlink
+      delete
+    end
+
+    def write(contents)
+      read
+
+      if append?
+        @contents = @contents.to_s
+        @contents += contents
+      else
+        @contents = contents
+      end
+
+      @contents
+    ensure
+      with_contents_persisted
+      @contents
+    end
+
+    def puts(contents)
+      contents = "#{ contents }\n" unless contents.to_s.match(/\n$/m)
+      write(contents)
+    end
+
+    def api_entity
+      @api_entity ||= GHFS.api.contents(repository, path: path, ref: ref)
+    rescue Octokit::NotFound
+      @new_file = true
+    rescue
+      nil
+    end
+
+    def with_contents_persisted
+      case
+      when read_only?
+        raise GHFS::ReadOnly
+      when !should_create? && new_file?
+        raise GHFS::NotFound
+      when new_file? && should_create?
+        @new_file = nil
+        message = "Creating #{ path }"
+        GHFS.api.create_contents(repository, path, message, encoded_contents, branch: branch)
+      when !new_file?
+        @new_file = nil
+        message = "Updating #{ path }"
+        GHFS.api.update_contents(repository, path, message, latest_sha, encoded_contents, branch: branch)
+      end
+    end
+
+    def encoded_contents
+      # the octokit gem handles encoding for us
+      contents.to_s
+    end
+
+    def new_file?
+      api_entity unless @api_entity
+      !@new_file.nil?
+    end
+
+    def latest_sha
+      !new_file? && api_entity && api_entity.sha
+    end
+
+    def exists?
+      !new_file?
+    end
+
+    def read_only?
+      mode == "r"
+    end
+
+    def append?
+      mode == "a" || mode == "a+"
+    end
+
+    def writable?
+      append? || mode == "w" || mode == "w+"
+    end
+
+    def should_create?
+      mode == "w+" || mode == "a+"
+    end
+
+    def ref
+      options.fetch(:ref) do
+        branch || options[:commit] || options[:tag] || "master"
+      end
+    end
+  end
+end

data/lib/github-fs/test_helpers.rb

@@ -0,0 +1,6 @@
+module GHFS
+  module TestHelpers
+    def self.test_branch
+    end
+  end
+end

data/lib/github-fs/util.rb

@@ -0,0 +1,43 @@
+module GHFS
+  module Util
+    def self.use_temporary_branch
+      GHFS.config.branch = temporary_branch
+      create_branch(temporary_branch)
+    end
+
+    def self.remove_temporary_branch
+      if temporary_branch_exists?
+        remove_branch(temporary_branch)
+      end
+    end
+
+    def self.temporary_branch_exists?
+      !@temporary_branch.nil?
+    end
+
+    def self.temporary_branch
+      @temporary_branch ||= "temp-branch-#{ rand(36**36).to_s(36).slice(0,8) }"
+    end
+
+    def self.create_branch(name, repo=nil)
+      if repo ||= GHFS.config.repository
+        master_branch = GHFS.api.branch(repo, "master")
+        master_sha = master_branch.commit.sha
+        refs = GHFS.api.create_ref(repo, "heads/#{ name }", master_sha)
+
+        ref = Array(refs).flatten.last
+        ref && ref.commit && ref.commit.sha
+      end
+    end
+
+    def self.remove_branch(name, repo=nil)
+      if repo ||= GHFS.config.repository
+        names = GHFS.api.branches(repo).map(&:name)
+
+        if names.any? {|n| n == name }
+          GHFS.api.delete_branch(repo, name)
+        end
+      end
+    end
+  end
+end

data/lib/github-fs/version.rb

@@ -0,0 +1,3 @@
+module GHFS
+  VERSION = '0.0.1'
+end

data/spec/lib/github-fs/config_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe GHFS::Config do
+  it "requires a github access token" do
+    expect(GHFS.config.github_access_token).not_to be_nil
+  end
+end

data/spec/lib/github-fs/file_spec.rb

@@ -0,0 +1,120 @@
+require "spec_helper"
+
+describe GHFS::File do
+  let(:file) do
+    GHFS::File.open("files/existing.txt")
+  end
+
+  let(:new_file) { GHFS::File.open("files/new.txt") }
+
+  describe "File Modes" do
+    it "knows if it should create a file that doesnt exist" do
+      %w(w+ a+).each do |mode|
+        file = GHFS::File.open("modes.txt", mode)
+        expect(file).to be_should_create
+      end
+    end
+
+    it "has modes which will not create new files" do
+      %w(w a).each do |mode|
+        file = GHFS::File.open("modes.txt", mode)
+        expect(file).not_to be_should_create
+      end
+    end
+
+    it "has append modes" do
+      file = GHFS::File.open("modes.txt", "a+")
+      expect(file).to be_append
+    end
+
+    it "has writable modes" do
+      %w(w a w+ a+).each do |mode|
+        file = GHFS::File.open("modes.txt", mode)
+        expect(file).to be_writable
+        expect(file).not_to be_read_only
+      end
+    end
+
+    it "has read only modes" do
+      file = GHFS::File.open("modes.txt", "r")
+      expect(file).not_to be_writable
+      expect(file).to be_read_only
+    end
+  end
+
+  describe "Flags" do
+    it "lets me know if a file exists" do
+      expect(file).to be_exists
+    end
+
+    it "lets me know if the file is a new file" do
+      expect(new_file).to be_new_file
+      expect(new_file).not_to be_exists
+    end
+  end
+
+  describe "Reading" do
+    it "lets me read the contents from a file" do
+      expect(file.read).to match("This is some existing content")
+    end
+  end
+
+  describe "Writing" do
+    it "fails if i attempt to perform an operation on a missing file and do not specify a create flag" do
+      expect(lambda do
+        GHFS::File.open("missing.txt", "a") do |fh|
+          fh.write("shit")
+        end
+      end).to raise_error(GHFS::NotFound)
+    end
+
+    it "lets me append to an existing file" do
+      GHFS::File.open("append-existing.txt", "w+") do |fh|
+        fh.write("begin")
+      end
+
+      file = GHFS::File.open("append-existing.txt", "a") do |fh|
+        fh.write("end")
+      end
+
+      content = file.read
+
+      expect(content).to include("begin")
+      expect(content).to include("end")
+    end
+
+    it "lets me append to or create a file" do
+      needle = rand(36**36).to_s(36)
+
+      expect(lambda do
+        GHFS::File.open("append-create.txt", "a+") do |fh|
+          fh.write("appending #{ needle }")
+        end
+      end).not_to raise_error
+
+      file = GHFS::File.open("append-create.txt","r")
+      expect(file.read).to include(needle)
+    end
+
+    it "lets me modify the contents of a file" do
+      content = file.read
+      needle = rand(36**36).to_s(36)
+      file.write("#{ content }\n#{ needle }")
+
+      modified = GHFS::File.open("files/existing.txt")
+      expect(modified.read).to match(content)
+      expect(modified.read).to match(needle)
+    end
+
+    it "lets me modify the contents of or create a file" do
+      brand_new = GHFS::File.open("files/brand-spanking-new.txt","w+") do |fh|
+        fh.write("this is some brand new stuff")
+      end
+
+      expect(brand_new).not_to be_new_file
+      expect(brand_new).to be_exists
+      expect(brand_new.latest_sha).not_to be_nil
+    end
+  end
+
+end

data/spec/lib/github_fs_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe GHFS do
+  it "should have access to the github api" do
+    expect(GHFS.api.user.login).not_to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'github-fs'
+require 'pry'
+
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.order = :random
+
+  config.before(:suite) do
+    cfg = YAML.load(IO.read(File.dirname(__FILE__) + "/credentials.yml"))
+
+    GHFS::Config.repository = cfg[:repository] || cfg["repository"]
+    GHFS::Config.github_access_token = cfg[:github_access_token] || cfg["github_access_token"]
+
+    GHFS::Util.use_temporary_branch
+  end
+
+  config.after(:suite) do
+    GHFS::Util.remove_temporary_branch
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: github-fs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Soeder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  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: rack
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !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: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: Creating, updating, deleting files on the github api using the same APIs
+  as you would working with files your local file system.
+email:
+- jonathan.soeder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- github-fs.gemspec
+- lib/github-fs.rb
+- lib/github-fs/config.rb
+- lib/github-fs/dir.rb
+- lib/github-fs/file.rb
+- lib/github-fs/test_helpers.rb
+- lib/github-fs/util.rb
+- lib/github-fs/version.rb
+- spec/lib/github-fs/config_spec.rb
+- spec/lib/github-fs/file_spec.rb
+- spec/lib/github_fs_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/architects/github-fs
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Work with the Github Contents API the way you would a normal file object
+test_files:
+- spec/lib/github-fs/config_spec.rb
+- spec/lib/github-fs/file_spec.rb
+- spec/lib/github_fs_spec.rb
+- spec/spec_helper.rb
+has_rdoc: