cid 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a650014d0d2a82c2d3426e9d9f0ba4b037595755
-  data.tar.gz: 7acf3492622ec5d725b99b6fa1f50c586520d0a0
+  metadata.gz: 5dd888724adb78e68f3a6760d4cb64317ca5e3e2
+  data.tar.gz: 610b3445181b32b18b0007f709e77185abf297b5
 SHA512:
-  metadata.gz: 3a96b0626ef40947282b8ed42bd977090ab973bc67b491eb88cb7a416cd97f46bdd7230bafc01a22bb742195e19376430d0a818438d88f2125f6d4763cbe9b2a
-  data.tar.gz: ee7428fdf1fa5d1e6fe424ccac98b678ac09731cf17bce72ef99dde3922d60d86165fa32cfc0f1f55ba86a0cbaaac67a2356050c19cc8f6dac433c861272e539
+  metadata.gz: f599d64d955fb3cc132bfc618210041f94ab421e893364ffb7f87612c6ec280a3f1aa2b978c88f94a0ef87b129ae8a0cddd512df1d67d554934465d58029d886
+  data.tar.gz: 40b378091289e6a7d048a1afd7a1b66d36e4ed6fd6d7b7e85ef42974bb4919c6d0d3b62b925cd5e7435cf1aee5e3db60a6b135e21fd9ee5c057ad7d6a332fa82

data/.travis.yml

@@ -10,4 +10,4 @@ notifications:
     on_failure: always
 env:
   global:
-    secure: HZhBJjfU3C6ub01Ioong30m3NMAoT5re8XwDg3VQ86L2Z/lz/Zz7FU+cJvLcJJaO7Jj7UmZK0ov0kFxIesIJMV/KsMfmMOlJjTMz0K5g/C/NaTIKlZTY4Mg53oS4fh0ZNogtfkttOfL/JLyNS2buuSEuMtFtC0+DXlqklQ/JT3w=
+  - secure: KTQ83GtNJyXwTUzYKbDtX1FzA3hsBSHefOqYsZ2KzOnj1dPZpGoeb4gcjWHXvNHqmR0mToT8U7KNq8AYWwHQLYCKf2+jRayd9UAzezhcs5u0SVfE5gmZLho57TW3AQvHI/uVQi9yg9/N3uDICqBplHJ7EMeMusUBc6ACF8FRmtY=

data/bin/cid

@@ -3,67 +3,109 @@ $:.unshift File.join( File.dirname(__FILE__), "..", "lib")
 
 require 'cid'
 require 'colorize'
+require 'thor'
 
-def print_error(index, error, color=:red)
-  location = ""
-  location += error.row.to_s if error.row
-  location += "#{error.row ? "," : ""}#{error.column.to_s}" if error.column
-  if error.row || error.column
-    location = "#{error.row ? "Row" : "Column"}: #{location}"
-  end
-  puts "#{index+1}. #{error.type}. #{location}".colorize(color)
-end
+class CidBin < Thor
 
-if ARGV[0] == "validate"
+  desc "validate PATH", "validate a package"
+  long_desc <<-LONGDESC
+    `cid validate` will validate a datapackage containing CSVs and schemas.
 
-  if ARGV[1]
-    source = ARGV[1]
-  else
-    source = "."
-  end
+    It expects CSVs of each type to be in folders, with the schema that
+    relates to them.
 
-  validation = Cid::Validation.validate(source)
+    By default, `cid validate` will look in your current folder, but you can
+    also specify which folder to look in:
 
-  code = 0
+    > $ cid validate /this/is/a/datapackage
+  LONGDESC
+  def validate(source = ".")
+    check_path(source)
 
-  validation.each do |k,v|
+    validation = Cid::Validation.validate(source)
 
-    puts "#{k} is #{(v[:errors] + v[:warnings]).count == 0 ? "VALID".green : "INVALID".red}"
+    code = 0
 
-    if v[:errors].length > 0
-      v[:errors].each_with_index do |error, i|
-        print_error(i, error)
-      end
-    end
+    validation.each do |k,v|
+      puts "#{k} is #{(v[:errors] + v[:warnings]).count == 0 ? "VALID".green : "INVALID".red}"
 
-    if v[:warnings].length > 0
-      v[:warnings].each_with_index do |error, i|
-        print_error(i, error)
-      end
+      v[:errors].each_with_index { |error, i| print_error(i, error) } if v[:errors].length > 0
+      v[:warnings].each_with_index { |error, i| print_error(i, error) } if v[:warnings].length > 0
+
+      code = 1 if (v[:errors] + v[:warnings]).count > 0
     end
 
-    code = 1 if (v[:errors] + v[:warnings]).count > 0
+    exit code
 
   end
 
-  exit code
+  desc "publish", "Publish a package to GitHub"
+  long_desc <<-LONGDESC
+    `cid publish` will create a new datapackage.json file based on the CSVs in
+    the package and push them to Github (unless you specify `--skip-github`)
+
+    By default, `cid publish` will look in your current folder, but you can
+    also specify which folder to look in:
+
+    > $ cid validate /this/is/a/datapackage
+  LONGDESC
+  option :github_token
+  option :skip_github, :type => :boolean
+  def publish(source = ".")
+    check_path(source)
+
+    github_token = options[:github_token] || ENV['GITHUB_OAUTH_TOKEN']
+
+    if github_token.blank? && !options[:skip_github]
+      error <<-ERROR
+        Github token not specified. Either add GITHUB_OAUTH_TOKEN as an
+        environment variable or `cid publish --github_token=TOKEN`
+      ERROR
+      puts error.colorize(:red)
+      exit 1
+    end
 
-elsif ARGV[0] == "publish"
+    datapackage = Cid::Datapackage.new(source)
+    datapackage.create
+    datapackage.write
+    puts "Datapackage created".colorize(:green)
+
+    unless options[:skip_github]
+      if File.exist?("#{source}/.git")
+        begin
+          datapackage.publish(github_token)
+          puts "Changes pushed successfully".colorize(:green)
+        rescue Github::Error::NotFound
+          puts "Github authorisation error. Are you allowed to push to this repo?".colorize(:red)
+          exit 1
+        end
+      else
+        puts "Git repo not found".colorize(:red)
+        exit 1
+      end
+    end
 
-  if ARGV[1]
-    source = ARGV[1]
-  else
-    source = "."
   end
 
-  datapackage = Cid::Datapackage.new(source)
-  datapackage.create
-  datapackage.write
-  if File.exist?("#{source}/.git")
-    datapackage.publish
-    puts "Changes pushed successfully".colorize(:green)
-  else
-    puts "Git repo not found".colorize(:red)
-    exit 1
-  end
+  private
+
+    def print_error(index, error, color=:red)
+      location = ""
+      location += error.row.to_s if error.row
+      location += "#{error.row ? "," : ""}#{error.column.to_s}" if error.column
+      if error.row || error.column
+        location = "#{error.row ? "Row" : "Column"}: #{location}"
+      end
+      puts "#{index+1}. #{error.type}. #{location}".colorize(color)
+    end
+
+    def check_path(path)
+      if !File.directory?(path)
+        puts "Path doesn't exist!".colorize(:red)
+        exit 1
+      end
+    end
+
 end
+
+CidBin.start(ARGV)

data/cid.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "github_api"
   spec.add_dependency "dotenv"
   spec.add_dependency "memoist"
+  spec.add_dependency "thor"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/features/publish.feature

@@ -5,6 +5,7 @@ Feature: Publish a datapackage
     Given I run `cp -r ../../spec/fixtures/valid valid`
     And I cd to "valid"
     When I run `cid publish`
+    Then the output should contain "Datapackage created"
     And I run `cat datapackage.json`
     Then the output should contain "votes/votes-1.csv"
 
@@ -12,6 +13,7 @@ Feature: Publish a datapackage
     Given I run `cp -r ../../spec/fixtures/multiple_files multiple_files`
     And I cd to "multiple_files"
     When I run `cid publish`
+    Then the output should contain "Datapackage created"
     And I run `cat datapackage.json`
     Then the output should contain "votes/votes-1.csv"
     And the output should contain "votes/votes-2.csv"
@@ -21,9 +23,38 @@ Feature: Publish a datapackage
     And I cd to "multiple_files"
     When I run `cid publish`
     Then the output should contain "Git repo not found"
+    And the exit status should be 1
 
   Scenario: Sucessfully push to Github
     Given I run `git clone https://github.com/theodi/cid-test.git`
     And I cd to "cid-test"
     When I successfully run `cid publish`
     Then the output should contain "Changes pushed successfully"
+
+  Scenario: Path doesn't exist
+    When I run `cid publish /this/is/fake`
+    Then the output should contain "Path doesn't exist!"
+    And the exit status should be 1
+
+  Scenario: Github token not specified
+    Given I set the environment variables to:
+      | variable           | value      |
+      | GITHUB_OAUTH_TOKEN |            |
+    When I run `cid publish`
+    Then the output should contain "Github token not specified"
+    And the exit status should be 1
+
+  Scenario: Failed Github push
+    Given I run `git clone https://github.com/pezholio/cid-test.git`
+    And I cd to "cid-test"
+    When I run `cid publish`
+    Then the output should contain "Github authorisation error"
+    And the exit status should be 1
+
+  Scenario: Skip GitHub
+    Given I run `cp -r ../../spec/fixtures/multiple_files multiple_files`
+    And I cd to "multiple_files"
+    When I run `cid publish --skip-github`
+    Then the output should contain "Datapackage created"
+    And the output should not contain "Git repo not found"
+    And the exit status should be 0

data/features/validate.feature

@@ -28,3 +28,8 @@ Feature: Validate a datapackage
   Scenario: Specify directory
     When I run `cid validate spec/fixtures/valid`
     Then the output should contain "votes/votes-1.csv is VALID"
+
+  Scenario: Path doesn't exist
+    When I run `cid validate /this/is/fake`
+    Then the output should contain "Path doesn't exist!"
+    And the exit status should be 1

data/lib/cid/datapackage.rb

@@ -47,8 +47,8 @@ module Cid
       File.open("#{@path}/datapackage.json", 'w') { |f| f.write(@json) }
     end
 
-    def publish
-      git = Cid::Publish.new(@path, ENV['GITHUB_OAUTH_TOKEN'])
+    def publish(token = ENV['GITHUB_OAUTH_TOKEN'])
+      git = Cid::Publish.new(@path, token)
       git.publish
     end
 

data/lib/cid/version.rb

@@ -1,3 +1,3 @@
 module Cid
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cid
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - pezholio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csvlint
@@ -108,6 +108,20 @@ dependencies:
     - - '>='
       - !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: bundler
   requirement: !ruby/object:Gem::Requirement