platformcraft-filespot 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35dccadd089a759ce2a50795b5732e8799662c7d
-  data.tar.gz: 1b0981f71db5ca94c4a4a33e8bc86c3df2b8b394
+  metadata.gz: f3cbc70d020bcd62346f1726886acc00a20b4a2e
+  data.tar.gz: cdb832f47944d0f0378c0678de16da3f1d6679ad
 SHA512:
-  metadata.gz: db1b43004260f73c12c3563fb0e65d8edb95a314676c2968c194e0b08fecc2fad54a954e42abe34a98cae83c1c1d37d0a23e4c2858d26ba1f3ee6b3717ae97e1
-  data.tar.gz: a77f09f9c38d0ae29bc09a49a9655431cd09db38e1e2a105103c56cc64e4e9592199641e8b4d323c456af1c72c67d4319cff988313bfb6267106bc587a41cc76
+  metadata.gz: 975d1d2ba3f209d8c98470dfb7ccb2a1aacaa0fe6c849fcafdb196ef691da914f50efeee8de72e708a95e64294beee93a42db8d3c6fc3649e6b69ac8453a629c
+  data.tar.gz: c3c7e031f6cfa2a79943e5f793f474b723d8fc3e7578ea42d90d456bd3c3e002c20821616e2fd54ab8fb3365625d8e43fb1fe297a9f49a3d2226248ad1a2bd6f

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 *.gem
+doc

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
 rvm:
- - 1.9
  - 2.1
  - 2.2

data/lib/filespot.rb

@@ -5,6 +5,8 @@ require 'filespot/request'
 require 'filespot/response'
 require 'filespot/client'
 
+##
+# Filespot gem module
 module Filespot
   extend Configuration
 end

data/lib/filespot/client.rb

@@ -2,6 +2,8 @@ require 'filespot/client/objects'
 require 'filespot/client/download'
 
 module Filespot
+  ##
+  # Client class provides a communication with API by methods
   class Client
     extend Objects
     extend Download

data/lib/filespot/client/download.rb

@@ -1,11 +1,17 @@
 module Filespot
+  ##
+  # Download module wraps methods with `/download` resource[http://doc.platformcraft.ru/filespot/api/#download]
   module Download
+    # POST /download
+    # returns task_id
     def post_download(url, path = nil)
       res = Response.new(Request.post("/download", {}, { url: url, path: path }))
       return nil unless res.code == 200
       res.data['task_id']
     end
 
+    # GET /download_tasks
+    # returns tasks list
     def get_download_tasks
       res = Response.new(Request.get("/download_tasks"))
       return [] unless res.code == 200
@@ -16,21 +22,29 @@ module Filespot
       arr
     end
 
+    # GET /download_tasks/{:task_id}
+    # returns task data
     def get_download_task(task_id)
       res = Response.new(Request.get("/download_tasks/#{task_id}"))
       return nil unless res.code == 200
       Task.new(res.data['task'], res.data['files'])
     end
 
+    # DELETE /download_tasks/{:task_id}
+    # returns removal status
     def delete_download_task(task_id)
       res = Response.new(Request.delete("/download_tasks/#{task_id}"))
       res
     end
   end
 
+  ##
+  # Task class provides task as object
   class Task
+    # files data
     attr_reader :files
 
+    # creates object
     def initialize(data, files = [])
       data.each { |k, v| define_singleton_method(k.to_sym) { v } }
       @files = files

data/lib/filespot/client/objects.rb

@@ -1,9 +1,9 @@
 module Filespot
+  ##
+  # Objects module wraps methods with `/objects` resource[http://doc.platformcraft.ru/filespot/api/#objects]
   module Objects
-    def exists?(path)
-      !!get_object_by_path(path)
-    end
-
+    # GET /objects
+    # returns an objects list
     def get_objects(folder=nil)
       res = Response.new(Request.get("/objects", folder: folder))
       return [] unless res.code == 200
@@ -14,12 +14,18 @@ module Filespot
       arr
     end
 
+    # GET /objects/{:object_id}
+    # returns an object
     def get_object(object_id)
       res = Response.new(Request.get("/objects/#{object_id}"))
       return nil unless res.code == 200
       Object.new(res.data['object'])
     end
 
+    # POST /objects
+    # * +file+ - file path(*required*)
+    # * +name+ - name that will be stored in API service
+    # returns a file info
     def post_object(file, name = nil)
       file_io = Faraday::UploadIO.new(file, 'application/octet-stream')
       res = Response.new(Request.post("/objects", {}, { file: file_io, name: name }))
@@ -28,28 +34,44 @@ module Filespot
       Object.new(res.data['object'])
     end
 
+    # DELETE /objects/{:object_id}
+    # returns removal status
     def delete_object(object_id)
       res = Response.new(Request.delete("/objects/#{object_id}"))
       res
     end
 
+    # deletes object which has been found by path
     def delete_object_by_path(path)
-      object = get_object_by_path path
+      object = get_object_by_path(path)
       return delete_object(object.id) if object
+
       nil
     end
 
+    # GET /objects/{:path}
+    # returns an objects list
     def get_object_by_path(path)
       full_path = path[0] == '/' ? path : "/#{path}"
-      folder = File.dirname full_path
+      folder = File.dirname(full_path)
+
       get_objects(folder).each do |object|
         return object if object.path == full_path
       end
+
       nil
     end
+
+    # checks if object exists
+    def exists?(path)
+      !!get_object_by_path(path)
+    end
   end
 
+  # Object class provides API object as ruby object
   class Object
+
+    # creates object
     def initialize(data)
       data.each { |k, v| define_singleton_method(k.to_sym) { v } }
     end

data/lib/filespot/configuration.rb

@@ -1,18 +1,35 @@
 module Filespot
+
+  ##
+  # Configuration module provides gem settings
+  #
+  #   Filespot.configure do |config|
+  #     config.url = 'api.platformcraft.ru'
+  #     config.version = 1
+  #     config.apikey = '12345'
+  #     config.apiuserid = '12345'
+  #   end
+  #
   module Configuration
+    # default API url
     API_URL = 'api.platformcraft.ru'
+    #default API version
     API_VERSION = 1
 
+    # options
     OPTIONS = [
       :url, :version, :apiuserid, :apikey
     ].freeze
 
+    # settings attributes
     attr_accessor *OPTIONS
 
+    # invoke module
     def self.extended(base)
       base.init
     end
 
+    # set default params
     def init
       self.url = API_URL
       self.version = API_VERSION
@@ -20,6 +37,7 @@ module Filespot
       self.apikey = nil
     end
 
+    # configure with gem settings
     def configure
       yield self
     end

data/lib/filespot/digest.rb

@@ -2,7 +2,11 @@ require 'openssl'
 require 'base64'
 
 module Filespot
+  ##
+  # Digest class provides some encryption features
   class Digest
+
+    # generates HMAC[https://en.wikipedia.org/wiki/Hash-based_message_authentication_code]
     def self.hmac(http_method, uri)
       data = "#{http_method.upcase}+#{URI.decode(uri).gsub(/\Ahttps?:\/\//, '')}"
       OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), Filespot.apikey, data)

data/lib/filespot/request.rb

@@ -2,18 +2,36 @@ require 'faraday'
 require 'open-uri'
 
 module Filespot
+  ##
+  # Request class wraps HTTP-verbs
   class Request
 
+    # GET
+    #
+    # * +api_method+ - API method name
+    # * +uri_params+ - contains API method params
     def self.get(api_method = '', uri_params = {})
       uri = api_uri('GET', api_method, uri_params)
       connection(uri).get(uri.query)
     end
 
+    # POST
+    #
+    # * +api_method+  - API method name
+    # * +uri_params+  - contains API method params
+    # * +post_params+ - contains API post params
+    #
+    # === Example
+    #   Request.post("/objects", {}, { file: file_io, name: name })
     def self.post(api_method = '', uri_params = {}, post_params = {})
       uri = api_uri('POST', api_method, uri_params)
       connection(uri).post(uri.query, post_params)
     end
 
+    # DELETE
+    #
+    # * +api_method+  - API method name
+    # * +uri_params+  - contains API method params
     def self.delete(api_method = '', uri_params = {})
       uri = api_uri('DELETE', api_method, uri_params)
       connection(uri).delete(uri.query)

data/lib/filespot/response.rb

@@ -1,9 +1,19 @@
 require 'json'
 
 module Filespot
+  ##
+  # Response class provides API response
   class Response
-    attr_reader :code, :status, :data
+    # HTTP code
+    attr_reader :code
 
+    # response status
+    attr_reader :status
+
+    # response data in JSON format
+    attr_reader :data
+
+    # creates response, checks errors and provides data if success
     def initialize(response)
       return error if response.status == 500
 

data/lib/filespot/version.rb

@@ -1,3 +1,4 @@
 module Filespot
-  VERSION = '0.1.4'.freeze
+  # gem version
+  VERSION = '0.1.5'.freeze
 end

data/platformcraft-filespot.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = "adroff@gmail.com"
   gem.description   = "gem provides platformcraft filespot api"
   gem.summary       = "http://doc.platformcraft.ru/filespot/api/"
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/droff/platformcraft-filespot"
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

data/spec/spec_helper.rb

@@ -24,21 +24,26 @@ RSpec.configure do |config|
   end
 end
 
+def uri
+  /api.platformcraft.ru\/1/
+end
+
+def headers
+  {
+    'Accept'=>'*/*',
+    'Accept-Encoding'=> 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+    'User-Agent'=> /Faraday/
+  }
+end
+
 def stub_get(api_method, fixture_name)
-  encoding = 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'
-  agent = 'Faraday v0.9.2'
-  uri = /api.platformcraft.ru\/1/
-  stub_request(:get, uri).with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=> encoding, 'User-Agent'=> agent}).to_return(status: 200, body: fixture(fixture_name), headers: {})
+  stub_request(:get, uri).with(headers: headers).to_return(status: 200, body: fixture(fixture_name), headers: {})
 end
 
 def stub_post(api_method, fixture_name)
-  encoding = 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'
-  agent = 'Faraday v0.9.2'
-  uri = /api.platformcraft.ru\/1/
   stub_request(:post, uri).with(headers: {'Accept'=>'*/*', 'Accept-Encoding'=> encoding, 'User-Agent'=> agent}).to_return(status: 200, body: fixture(fixture_name), headers: {})
 end
 
-
 def fixture_path
   File.expand_path("../fixtures", __FILE__)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: platformcraft-filespot
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - droff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -113,7 +113,7 @@ files:
 - spec/lib/digest_spec.rb
 - spec/lib/response_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/droff/platformcraft-filespot
 licenses: []
 metadata: {}
 post_install_message: 
@@ -132,19 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: http://doc.platformcraft.ru/filespot/api/
-test_files:
-- spec/fixtures/download_tasks.json
-- spec/fixtures/download_tasks_id.json
-- spec/fixtures/objects.json
-- spec/fixtures/objects_id.json
-- spec/fixtures/objects_post.json
-- spec/lib/client/download_spec.rb
-- spec/lib/client/objects_spec.rb
-- spec/lib/client_spec.rb
-- spec/lib/digest_spec.rb
-- spec/lib/response_spec.rb
-- spec/spec_helper.rb
+test_files: []