bonsai_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0436aa3576974561c877f20e7ed166c0481329b9
-  data.tar.gz: 516009c69e91c5c26abc5ca827f85308a79a42eb
+  metadata.gz: 5cba822dab0323ad666691294efcea55e72cd543
+  data.tar.gz: e44e02ab043734bd4f3d37c196d6934c580fc61a
 SHA512:
-  metadata.gz: 8e98178eafc87223eeef24fe87b86f1140741372510f6f4b2dee0d9821a3175f5e77455b8bf7027806a58586dd4e68f78579b6761314f4eb9cdbdc256dac2b89
-  data.tar.gz: df4534e6eafb5a2900a72b568161291d01a902982893b728544a402a248635d0500cf518ec63d9f6a0566137b09d7e504932f48f7af1debb40e4c09e277b651e
+  metadata.gz: cac296df7bad1cea1cc1b4ca950f2c255d8306f32b951088dc80b98b09ec874bc630e4744d2a6a1235e61f21942bfbd2b2b44bf672e956468bf4fa8b6570855d
+  data.tar.gz: 14bcc818aa9c8d25836067355e42f5c569cb2f272c143ca61cf49ed58688574f188e950fde9c2eec3fa05230ccf5a5e7ebaec489c8d385d2f02e3d71207fe2c5

data/.gitignore

@@ -1,4 +1,7 @@
 
+# Local files
+NOTES.local.md
+
 # Specific environment configuration
 /config/environments/*
 !/config/environments/.keep

data/{.gitlab-ci-tempalte.yml → .gitlab-ci.yml}

@@ -2,7 +2,7 @@ image: "ruby:2.4"
 
 before_script:
   - ruby -v
-  - gem install bundler  --no-ri --no-rdoc 
+  - gem install bundler --version "~> 1.12" --no-document
   - bundle install
 
 tests:

data/.yardopts

@@ -0,0 +1,4 @@
+
+--markup-provider=redcarpet
+--markup=markdown
+

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 ## [Unreleased]
 * ...
 
+## [0.1.1] - 2019-03-02
+* Upload a file.
+* Documentation.
+
 ## [0.1.0] - 2019-03-01
 * First version.
 

data/Gemfile

@@ -5,4 +5,7 @@ gemspec
 
 group :test, :development do
   gem 'minitest-reporters'
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'github-markup'
 end

data/README.md

@@ -16,6 +16,8 @@ gem install bonsai_client
 
 ## Usage in shell
 
+Upload a file:
+
 ```bash
 bonsai_client upload --url="http://bonsai-server.com" --path="/path/to/file"
 ```
@@ -26,16 +28,16 @@ bonsai_client upload --url="http://bonsai-server.com" --path="/path/to/file"
 # Require Bonsai Client gem.
 require 'bonsai-client'
 
-# Creata a new instance of Bonsai client:
+# Create a new instance of Bonsai client:
 bonsai = BonsaiClient.new(url: 'http://bonsai-server.com')
 
 # Upload a file to a Bonsai server:
-result = bonsai.upload(path: '/path/to/file')
+response = bonsai.upload(path: '/path/to/my-file')
 
 # URL for a specific file in Bonsai sever:
-src1 = bonsai.thumbnail_url(checksum: 'AF1...') # http://bonsai-server.com/thumbnails/AF1...
-src2 = bonsai.thumbnail_url(name: 'myfile') # http://bonsai-server.com/...
-src3 = bonsai.thumbnail_url(checksum: 'AF1...', size: :medium) # http://bonsai-server.com/thumbnails/AF1.../size/medium
+src1 = bonsai.thumbnail_url(checksum: response[:data][:file_checksum]) 
+src2 = bonsai.thumbnail_url(name: 'my-file')
+src3 = bonsai.thumbnail_url(checksum: response[:data][:file_checksum]), size: :medium) 
 ```
 
 ## Development
@@ -43,35 +45,44 @@ src3 = bonsai.thumbnail_url(checksum: 'AF1...', size: :medium) # http://bonsai-s
 ### Test
 
 ```bash
-bundle exec rake test
+BONSAI_SERVER_URL=https://xxx.yyy BONSAI_CLIENT_ID=zzz bundle exec rake test
+BONSAI_SERVER_URL=https://xxx.yyy BONSAI_CLIENT_ID=zzz bundle exec rake test TEST=test/upload_file_test.rb
 ```
 
 ### Rake tasks
 
-Crea una nueva versión de la gema (sin subirla a ruby gems pero sí a GitLab y GitHub):
+Create a new version:
 
 ```bash
 rake release
 ```
 
-Sube commits a los repositorios git:
+Push commits to git repositories (GitLab and GitHub)
 
 ```bash
 rake push
 ```
 
-Publica la última versión de la gema en Rubygems:
+Publish the current gem version to Rubygems:
 
 ```bash
 rake push
 ```
 
-Muestar la versión actual de la gema:
+Show current gem version:
 
 ```bash
 rake version
 ```
 
+### Documentation
+
+Create documentation:
+
+```bash
+yardoc
+```
+
 
 ## License
 

data/Rakefile

@@ -70,6 +70,16 @@ end
 
 task :default => :test
 
+desc "Push code to the remote respositories"
+task :push do
+  show_text ">> Pushing code to GitLab y GitHub"
+  puts ""
+  sh "git push origin master"
+  puts ""
+  sh "git push github master"
+  puts ""
+end
+
 desc "Release #{gem_file} (only repository, not RubyGems)"
 task :release => :build do
   show_text ">> Releasing #{gem_file}"
@@ -97,16 +107,6 @@ task :release => :build do
   show_release
 end
 
-desc "Push code to the remote respositories"
-task :push do
-  show_text ">> Pushing code to GitLab y GitHub"
-  puts ""
-  sh "git push origin master"
-  puts ""
-  sh "git push github master"
-  puts ""
-end
-
 desc "Build #{gem_file} into pkg folder"
 task :build do
   show_text ">> Creating #{gem_file}"

data/bonsai_client.gemspec

@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
   s.executables = all_files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.bindir        = "exe"
   s.require_paths = ["lib"]
-  s.add_development_dependency "bundler", "~> 1.12"
+  s.add_runtime_dependency 'rest-client', '~> 2.0'
+  s.add_development_dependency 'bundler', "~> 1.12"
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency 'minitest', '~> 5.0'
 end

data/lib/bonsai_client/client.rb

@@ -2,7 +2,38 @@ module BonsaiClient
   # Client for a Bonsai server.
   class Client
 
+    # @param [Hash] opts Otions to create the client.
+    # @option opts [String] :url Bonsai server URL (such as https://bonsai-server.com)
+    # @option opts [String] :client_id Unique ID for each client
     def initialize(opts = {})
+      @url = opts[:url] || ''
+      @client_id = opts[:client_id] || ''
+    end
+
+    # Upload a file.
+    #
+    # @param [Hash] opts Otions to upload a file.
+    # @option opts [String] :path File path
+    #
+    # @return [Hash] Response from Bonsai server.
+    def upload(opts = {})
+      path = opts[:path] || ''
+      raise_no_file_path! if path.empty?
+      response = RestClient.post(
+        upload_url,
+        file: File.new(path, 'rb')
+      )
+      JSON.parse(response.to_str, symbolize_names: true)
+    end
+
+    private
+
+    def raise_no_file_path!
+      raise 'No file path'
+    end
+
+    def upload_url
+      "#{@url}/api/client/#{@client_id}/upload"
     end
 
   end

data/lib/bonsai_client/version.rb

@@ -1,4 +1,4 @@
 module BonsaiClient
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
   NAME = 'bonsai_client'.freeze
 end

data/lib/bonsai_client.rb

@@ -1,22 +1,35 @@
 def require_all(path)
-  glob = File.join(__dir__, path, "*.rb")
+  glob = File.join(__dir__, path, '*.rb')
   Dir[glob].sort.each do |f|
     require f
   end
 end
 
 # stdlib
-require "fileutils"
-require "ostruct"
-require_all "bonsai_client"
+require 'fileutils'
+require 'ostruct'
+require 'json'
+require 'rest-client'
+require_all 'bonsai_client'
 
 module BonsaiClient
 
-  # Client for a Bonsai server.
+  # Create a new client for a Bonsai server.
+  #
+  # @param [Hash] opts Otions to create the client.
+  # @option opts [String] :url Bonsai server URL (such as https://bonsai-server.com)
+  # @option opts [String] :client_id Unique ID for each client
   #
   # @return [Client]
   def self.create(opts = {})
     Client.new(opts)
   end
+
+  # Extract file checksum from response data.
+  #
+  # @return [String]
+  def self.checksum_from_response(response)
+    response[:data][:file_checksum]
+  end
   
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bonsai_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Manu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2019-03-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -60,8 +74,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".gitlab-ci-tempalte.yml"
+- ".gitlab-ci.yml"
 - ".travis-template.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -73,6 +88,7 @@ files:
 - lib/bonsai_client/client.rb
 - lib/bonsai_client/version.rb
 - test-data/.keep
+- test-data/sample.jpg
 homepage: https://gitlab.com/galfuslab/bonsai-client
 licenses:
 - MIT