bucket-cli 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40c5f1a4499778d641fb6a1b843721593567ad5a
-  data.tar.gz: 42a542e11a64d789a7822870bc56534f6b3ceab0
+  metadata.gz: e1e3681f9ff4782374b1160d5cb5233d5af92c5b
+  data.tar.gz: 760a5ebe6ca705b6e8f562f8880b63712f506e63
 SHA512:
-  metadata.gz: 4e4205cf5d982a68596797778235cf000bdc7013c197b7eaebbc5255cadcc2dc3c1528e12cd198a484d263468330a27bc95218b0cbb07dcf727c3418fb077eeb
-  data.tar.gz: 2fc5dc71f444b063efb848912f3ef2792308ef0ce9fa2f1a76205f9dc73881d48b642d94e41ed7b4f8612cc889aa226453c23aa13cebb802d566c7e7f617a39a
+  metadata.gz: 6cc1cdd1e06906714963ba2e9338a98a0be813df258e1cc13399709fee548ff25dcecee732e114e336083b0812f77180dd0c85738c7a5ff219b364ec32a9f3b9
+  data.tar.gz: 790ff1a30c0fbd0eaa8f19197ab4c1f085d955553dfe70468c6d596db06f0d3bf3a007bea443ad8893e631e64152e02f988cdf3b44803959571c46d271e2cc65

data/README.md

@@ -1,24 +1,89 @@
 # Bucket
 
-TODO: Write a gem description
+A Command Line Interface for [BitBucket](https://bitbucket.org).
+*For now, only `git` is supported. Mercurial support is planned.*
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'bucket'
+~~~ sh
+gem 'bucket-cli'
+~~~
 
 And then execute:
 
-    $ bundle
+~~~ sh
+$ bundle
+~~~
 
 Or install it yourself as:
 
-    $ gem install bucket
+~~~ sh
+$ gem install bucket-cli
+~~~
 
 ## Usage
 
-TODO: Write usage instructions here
+### Setup
+After the installation, you can run
+
+~~~ sh
+$ bucket setup
+~~~
+
+to start the configuration.
+
+You need to add your BitBucket username and password (for now it's saved in *plaintext* in `~/.bucket` with a permission bit of `0600`, in the future this will change for oauth authorization).
+
+### Init repository
+You can initialize a new repository (as in doing `git init`), and automagically creating the repository on BitBucket and adding the remote to `origin`.
+
+~~~ sh
+$ bucket init DIRECTORY
+~~~
+
+This will create a new (private) repository in `DIRECTORY` (can be `.` for current directory), and create a repository named after the destination folder (or as specified in the options) in your BitBucket account.
+
+#### Options
+
+    --name        NAME  A name for the repository in BitBucket
+    --description DESC  A description for the repository in BitBucket
+    --public            Mark the repository as public (private by default)
+
+### Cloning
+You can clone a repository directly from BitBucket with
+
+~~~ sh
+$ bucket clone [USER]/REPOSITORY
+~~~
+
+where `REPOSITORY` is the repository name.
+
+If `[USER]` is not supplied, it's assumed you want a repository from your own account. For example, if you want to clone the `bucket-cli` repository from your own account you can just use
+
+~~~ sh
+$ bucket clone bucket-cli
+~~~
+
+but if it's from another account you need to specify it
+
+~~~ sh
+$ bucket clone xaro/bucket-cli
+~~~
+
+### Listing repositories
+You can list the repositories associated with your account by using
+
+~~~ sh
+$ bucket repos
+~~~
+
+## TODO
+* Improve error reporting (and exceptions catching)
+* Add more commands
+* Shallow redirect commands to git / mercurial
+* Replace bitbucket api gem (it has too many dependencies and is not complete)
 
 ## Contributing
 

data/Rakefile

@@ -5,6 +5,7 @@ task :default => :spec
 
 Rake::TestTask.new(:spec) do |t|
   t.test_files = FileList['spec/**/*_spec.rb']
+  t.libs.push 'spec'
 end
 
 desc "Console"

data/bucket.gemspec

@@ -18,12 +18,21 @@ Gem::Specification.new do |spec|
   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 "omniauth"
   spec.add_dependency "thor"
   spec.add_dependency "bitbucket_rest_api"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  # Git access via Ruby
+  spec.add_dependency "git"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
+
+  # Fake the filesystem
+  spec.add_development_dependency "fakefs"
+
+  # Mocks
+  spec.add_development_dependency "rr"
 end

data/lib/bucket/cli.rb

@@ -1,14 +1,19 @@
 require "thor"
 require "io/console"
 require "yaml"
+require "git"
 require_relative "../bucket"
 
 module Bucket
   class CLI < Thor
+    include Thor::Actions
+
+    CONFIG_FILE_PATH = "#{Dir.home}/.bucket"
+
     def initialize(*args)
       super
 
-      @client = Bucket::Client.new load_config
+      @client = Bucket::Client.new(load_config)
     end
 
     desc "setup", "Setup your BitBucket credentials"
@@ -25,38 +30,46 @@ module Bucket
       end
     end
 
-    desc "clone [USER] [NAME]", "Clone repository USER/NAME from bitbucket."
-    def clone(user, name)
-      `git clone #{@client.repo_url(user, name)}`
+    desc "clone [USER]/REPOSITORY", "Clone repository REPOSITORY from bitbucket.\nIf [USER] is ommited, it is assumed that it's your BitBucket user."
+    def clone(name)
+      begin
+        repository = Git::Base.clone(@client.repo_url(name), name)
+        say("Repository cloned to #{repository.dir}")
+      rescue Git::GitExecuteError => e
+        say("Could not clone repository")
+        say(e.message)
+      end
     end
 
-    desc "init [directory]", "Create a new repository locally and on BitBucket."
-    option :name
-    option :description
-    option :public, type: :boolean, default: false
+    desc "init DIRECTORY", "Create a new repository locally and on BitBucket."
+    option :name, desc: "The name of the repository. If not specified, the current folder will be used."
+    option :description, desc: "A description for the repository."
+    option :public, desc: "Sets if the repository is public or private.", type: :boolean, default: false
     def init(directory)
       expanded_dir = File.expand_path(directory)
-      `git init #{expanded_dir}`
-      
-      repo = @client.create_repo(options[:name] || File.basename(expanded_dir), options)
-      `git remote add origin #{@client.repo_url(repo[:owner], repo[:slug])}`
+      repository = Git::Base.init(expanded_dir)
 
-      say("Repository #{@client.repo_full_name(repo)} created.")
+      # Create the BitBucket repository and add it to the local remotes
+      remote_repository = @client.create_repo(options[:name] || File.basename(expanded_dir), options)
+      remote_url = @client.repo_url("#{remote_repository[:owner]}/#{remote_repository[:slug]}")
+      repository.add_remote("BitBucket", remote_url)
+
+      say("Repository #{@client.repo_full_name(remote_repository)} with remote #{remote_url} created.")
     end
 
     private
     def load_config
-      YAML.load_file("#{Dir.home}/.bucket")
+      YAML.load_file(CONFIG_FILE_PATH)
     rescue
       generate_config
     end
 
     def generate_config
-      save_config ask_credentials
+      save_config(ask_credentials)
     end
 
     def save_config(credentials)
-      File.open "#{Dir.home}/.bucket", 'w' do |f|
+      File.open CONFIG_FILE_PATH, 'w', 0600 do |f|
         YAML.dump(credentials , f)
       end
 
@@ -64,10 +77,12 @@ module Bucket
     end
 
     def ask_credentials
-      username = @shell.ask("Username:")
-      @shell.say("Password: ")
-      password = $stdin.noecho(&:gets).strip
-      @shell.say("")
+      username = ask("Username:")
+
+      # Avoid echoing the password
+      password = ask("Password:", echo: false)
+
+      say("\nWARNING: For now, the password is saved IN PLAIN TEXT in the ~/.bucket file.")
 
       { "username" => username, "password" => password }
     end

data/lib/bucket/client.rb

@@ -3,17 +3,33 @@ module Bucket
     GIT_URL = "git@bitbucket.org"
 
     def initialize(credentials)
-      @connection = BitBucket.new basic_auth: "#{credentials["username"]}:#{credentials["password"]}"
+      @connection = BitBucket.new(basic_auth: "#{credentials["username"]}:#{credentials["password"]}")
+      @user = credentials["username"]
     end
 
     def repos_list
       @connection.repos.list
     end
 
-    def repo_url(user, name)
-      "#{GIT_URL}:#{user}/#{name}.git"
+    # Full url for the given repository
+    # The repository name must be of the style [USER]/[REPOSITORY] or
+    # [REPOSITORY] in which case the name of the current user
+    # will be used as owner
+    def repo_url(name)
+      split_name = name.split "/"
+
+      if split_name.size == 1
+        user = @user
+        slug = split_name[0]
+      else
+        user = split_name[0]
+        slug = split_name[1]
+      end
+
+      "#{GIT_URL}:#{user}/#{slug}.git"
     end
 
+    # A repository full name is of the style of [USER]/[REPOSITORY]
     def repo_full_name(repo)
       "#{repo[:owner]}/#{repo[:slug]}"
     end
@@ -24,6 +40,5 @@ module Bucket
 
       @connection.repos.create(options.merge(name: name))
     end
-
   end
 end

data/lib/bucket/version.rb

@@ -1,3 +1,3 @@
 module Bucket
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/bucket/cli_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'fakefs/safe'
+
+describe Bucket::CLI do
+  subject { Bucket::CLI.new }
+
+  # Use a fake filesystem and clear it after each test
+  before do
+    mock_credentials
+    FakeFS.activate!
+
+    # Create a fake user's home (in reality this folder will exist)
+    FileUtils.mkdir_p(Dir.home)
+  end
+  after do
+    FakeFS.deactivate!
+    FakeFS::FileSystem.clear
+  end
+
+  it "saves the user and password to the configuration file" do
+    # The setup is run when initializing the CLI
+    out = capture_io { subject }
+
+    config = YAML.load_file(Bucket::CLI::CONFIG_FILE_PATH)
+    config.must_equal({ "username" => "user", "password" => "password" })
+  end
+
+  it "replaces the user and password when calling setup" do
+    # Run the setup when initializing (and ignore output)
+    capture_io { subject }
+
+    # Run the setup again with other credentials
+    mock_credentials("other_user", "other_password")
+    capture_io { subject.setup }
+
+    config = YAML.load_file(Bucket::CLI::CONFIG_FILE_PATH)
+    config.must_equal({ "username" => "other_user", "password" => "other_password" })
+  end
+
+  it "displays a list of the user's repositories" do
+    any_instance_of(Bucket::Client) do |client|
+      mock(client).repos_list do
+        [
+          { owner: "user", slug: "repository" },
+          { owner: "other_user", slug: "other_repository" }
+        ]
+      end
+    end
+
+    out = capture_io { subject.repos }.join('')
+    out.must_match(/user\/repository/)
+    out.must_match(/other_user\/other_repository/)
+  end
+end
+
+def mock_credentials(username = "user", password = "password")
+  any_instance_of(Bucket::CLI) do |cli|
+    mock(cli).ask("Username:") { username }
+    mock(cli).ask("Password:", anything) { password }
+  end
+end

data/spec/bucket/client_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Bucket::Client do
+  subject { Bucket::Client.new({ "username" => "user", "password" => "password" }) }
+
+  it "returns the correct repository url when using USER/REPOSITORY syntax" do
+    subject.repo_url("other_user/repository").must_equal("git@bitbucket.org:other_user/repository.git")
+  end
+
+  it "returns the correct repository url when using REPOSITORY syntax" do
+    subject.repo_url("repository").must_equal("git@bitbucket.org:user/repository.git")
+  end
+
+  it "returns the full name of a repository from a hash containing the repository information" do
+    repo_hash = { owner: "user", slug: "repository" }
+
+    subject.repo_full_name(repo_hash).must_equal("user/repository")
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,28 @@
 require "minitest/autorun"
 require "minitest/pride"
 
-require_relative "../lib/bucket"
+require 'rr'
+
+require_relative "../lib/bucket"
+require_relative "../lib/bucket/cli"
+
+# Thor complains when a task does not have a description, we
+# need to silence it when mocking commands
+# https://github.com/jondot/logbook/blob/master/spec/spec_helper.rb
+require 'thor'
+class Thor
+  class << self
+    def create_command(meth) #:nodoc:
+      if @usage && @desc
+        base_class = @hide ? Thor::HiddenTask : Thor::Task
+        tasks[meth] = base_class.new(meth, @desc, @long_desc, @usage, method_options)
+        @usage, @desc, @long_desc, @method_options, @hide = nil
+        true
+      elsif self.all_tasks[meth] || meth == "method_missing"
+        true
+      else
+        false
+      end
+    end
+  end
+end

metadata

@@ -1,97 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: bucket-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Roberto Poo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2014-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
   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: thor
   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: bitbucket_rest_api
   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: git
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
 - !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: 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'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  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: rr
+  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: CLI for BitBucket
@@ -102,7 +144,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,7 +155,8 @@ files:
 - lib/bucket/cli.rb
 - lib/bucket/client.rb
 - lib/bucket/version.rb
-- spec/bucket_spec.rb
+- spec/bucket/cli_spec.rb
+- spec/bucket/client_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/xaro/bucket
 licenses:
@@ -125,22 +168,23 @@ 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.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Easily clone and create repositories in BitBucket from the command line.
   Init and link the local repository with a new BitBucket one in one command.
 test_files:
-- spec/bucket_spec.rb
+- spec/bucket/cli_spec.rb
+- spec/bucket/client_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/bucket_spec.rb

@@ -1,3 +0,0 @@
-describe "Bucket" do
-  subject { Bucket }
-end