putio-rb 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f712fea4767df51ec90b69b5592d0ed3a5e38689
+  data.tar.gz: abd9eb37ff2832cb85aa81239f83b7c6722a5d36
+SHA512:
+  metadata.gz: ab42d068ab464bce698480b2f13164087fabf270a8d155cccb114f0f8367d96acd7606fc3007f9fdcf72b785d4c37b520cb30dca0121450eb4a3d3a8e9951da3
+  data.tar.gz: 18321b87e58939c827af1acfe13fb4a9e2b922088273b6b4c8a74b18783f11902ad5269942f208565bacd121822ed0ab03f32ec75fe7970a86a526b7d2d26d35

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+*.gem
+.ruby-version
+doc/
+.yardoc/

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 2.1.2
+
+before_install:
+  - 'echo ''gem: --no-ri --no-rdoc'' > ~/.gemrc'
+
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :development do
+  gem 'yard'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'guard-rspec'
+  gem 'webmock'
+  gem 'pry'
+  gem 'pry-nav'
+  gem 'terminal-notifier-guard'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    putio-rb (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.5)
+    guard (2.6.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    listen (2.7.9)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rake (10.1.0)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+    safe_yaml (1.0.3)
+    slop (3.6.0)
+    terminal-notifier-guard (1.5.3)
+    thor (0.19.1)
+    timers (1.1.0)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  guard-rspec
+  pry
+  pry-nav
+  putio-rb!
+  rake
+  rspec
+  terminal-notifier-guard
+  webmock
+  yard

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/support/shared_examples/(.+)\.rb$}) { "spec" }
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013-2014 Thibault Gautriaud
+
+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,97 @@
+# putio-rb [![Build Status](https://travis-ci.org/hubb/putio.rb.svg?branch=master)](https://travis-ci.org/hubb/putio.rb)
+
+A wrapper around [put.io](https://put.io) api v2 which allows you to access all
+your files and transfers.
+
+## Install
+
+    gem install putio-rb
+
+## Usage
+
+First, you'll need to generate an access token, please see [the documentation](http://put.io/v2/docs/gettingstarted.html#authentication-and-access).
+
+### Configuration
+
+```
+require 'putio-rb'
+
+Putio.configure do |config|
+  config.access_token = 'SECRET TOKEN' # mandatory
+  config.api_endpoint = 'https://foo.bar'
+  config.api_version  = 'v1'
+  config.user_agent   = 'kthxbye'
+end
+```
+
+### Files
+
+```
+# list all files
+client.list_files
+# also aliased as files
+client.files
+# list files in directory 123
+client.files(options: { parent_id: 123 })
+# search a file
+client.search query: 'foo'
+# complex search
+client.search(query: 'jazz', options: { from: 'me,jack', ext: 'mp4', time: 'today' })
+# find a file
+client.file id: 123
+# delete files 123 and 345
+client.delete_files(123, 345)
+```
+
+### Transfers
+
+```
+# list all transfers
+client.list_transfers
+# also aliased as transfers
+client.transfers
+```
+
+## Todo
+
+### Files
+
+- [x] list files
+- [x] search files
+- [ ] upload file
+- [ ] create folder
+- [x] get file
+- [x] delete file
+- [ ] rename file
+- [ ] move file
+- [ ] convert file to mp4
+- [ ] get mp4 status
+- [ ] download
+- [ ] zip & download
+- [ ] subtitles
+- [ ] download subtitles
+
+### Transfers
+
+- [x] list transfers
+- [ ] add transfer
+- [ ] get transfer
+- [ ] retry transfer
+- [ ] cancel transfer
+- [ ] clean transfers
+
+### Friends
+
+- [ ] list friends
+- [ ] friend requests
+- [ ] send request
+- [ ] deny request
+
+### Account
+
+- [ ] info
+- [ ] settings
+
+## License
+
+See [LICENSE](https://github.com/hubb/putio.rb/blob/master/LICENSE.md)

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+namespace :doc do
+  begin
+    require 'yard'
+    YARD::Rake::YardocTask.new do |task|
+      task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
+      task.options = [
+        '--output-dir', 'doc/yard',
+        '--markup', 'markdown',
+      ]
+    end
+  rescue LoadError
+    puts "Please install yard for documentation support: gem install yard"
+  end
+end

data/lib/putio-rb.rb

@@ -0,0 +1,22 @@
+lib = File.expand_path('lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'putio/client'
+require 'forwardable'
+
+module Putio
+  class << self
+    include Putio::Configurable
+    extend Forwardable
+
+    def_delegators :client,
+                   :list_files, :files, :search, :file, :delete_file,
+                   :list_transfers, :transfers
+
+    def client
+      @client ||= Client.new(options)
+    end
+  end
+end
+
+Putio.setup

data/lib/putio/client.rb

@@ -0,0 +1,81 @@
+require 'putio/connection'
+require 'putio/defaults'
+require 'putio/configurable'
+require 'putio/client/files'
+require 'putio/client/transfers'
+
+module Putio
+  class Client
+    include Putio::Configurable
+    include Putio::Client::Files
+    include Putio::Client::Transfers
+
+    attr_writer :connection
+
+    def initialize(options = {})
+      Putio::Configurable.keys.each do |key|
+        public_send(:"#{key}=", options.fetch(key) { Putio.public_send(:"#{key}") })
+      end
+    end
+
+    # Text representation of the client, access token being masked
+    #
+    # @return [String]
+    def inspect
+      inspected = super
+      # mask access_token
+      inspected = inspected.gsub! access_token, "*******" if access_token
+      inspected
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param path [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Putio::Resource]
+    def get(path, options = {})
+      request :get, path, options
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param path [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Putio::Resource]
+    def post(path, options = {})
+      request :post, path, options
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param path [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Putio::Resource]
+    def put(path, options = {})
+      request :put, path, options
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param path [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Putio::Resource]
+    def delete(path, options = {})
+      request :delete, path, options
+    end
+
+    private
+    def request(method, path, params)
+      params = params.merge(oauth_token: access_token)
+      path   = File.join('/', api_version, path)
+
+      connection.request_json(method, path, params)
+    end
+
+    def connection
+      @connection ||= Connection.new(endpoint: api_endpoint,
+                                      headers: default_headers)
+    end
+
+  end
+end

data/lib/putio/client/files.rb

@@ -0,0 +1,107 @@
+require 'putio/resource/file'
+
+module Putio
+
+  class Client
+
+    module Files
+      # Lists files in a folder
+      #
+      # @param options [Hash]
+      # @option options [Integer] parent_id: ID of the folder you’d like to list. This defaults to the root directory (which has ID number 0).
+      # @alias files
+      #
+      # @return [Array<Putio::Resource::File>]
+      def list_files(options:{})
+        defaults = { parent_id: 0 }
+        options  = defaults.merge!(options)
+
+        resp = get '/files/list', options
+        resp.body["files"].inject([]) do |memo, data|
+          memo.push file_factory.call(data)
+        end
+      end
+      alias :files :list_files
+
+      # Search a file
+      #
+      # @param query [String] The keyword to search
+      # @param options [Hash] Search Syntax params
+      # @option options [Integer] page:  Defaults to 1. If -1 given, returns all results at a time.
+      # @option options [String] from:  me, shares, jack or all
+      # @option options [String] type: video, audio, image, iphone or all
+      # @option options [String] ext:  mp3, avi, jpg, mp4 or all
+      # @option options [String] time: today, yesterday, thisweek or all
+      # @example
+      #   result = client.search(query: "foo")
+      #   # => returns first page of results for "foo"
+      #
+      #   result = client.search(query: "foo", page: 2)
+      #   # => returns page 2 of results for "foo"
+      #
+      #   result = client.search(query: "foo", page:-1)
+      #   # => returns all results for "foo"
+      #
+      #   result = client.search(query: 'jazz', options: { from: 'me,jack', ext: 'mp4', time: 'today' })
+      #   # => Searches yours and jack’s files with the word jazz in its title which has the extension mp3 and created today.
+      #
+      #   result = client.search(query: 'jazz album', options: { from: 'shares', time: 'thisweek' })
+      #   # => Searches items shared with you with jazz album which are created thisweek
+      #
+      #   result = client.search(query: 'jazz', options: { type: 'iphone' })
+      #   # => Searches your files and items shared with the word jazz in its title which are converted to mp4
+      #
+      # @return [Array<Putio::Resource::File>]
+      def search(query:, options: {})
+        valid_search_options = %i{ page from type ext time }
+        options.select! { |o| valid_search_options.include?(o) }
+
+        page = options.delete(:page)
+        path = if page
+          "/files/search/#{query}/page/#{page}"
+        else
+          "/files/search/#{query}"
+        end
+
+        resp = get path, options
+
+        resp.body["files"].inject([]) do |memo, data|
+          memo.push file_factory.call(data)
+        end
+      end
+
+      # Returns a file’s properties.
+      #
+      # @param id [Integer]
+      # @param options
+      # @option options [Integer] parent_id: ID of the folder you’d like to list. This defaults to the root directory (which has ID number 0).
+      # @return [Putio::Resource::File]
+      def file(id:, options:{})
+        defaults = { parent_id: 0 }
+        options  = defaults.merge!(options)
+
+        resp = get "/files/#{id}", options
+        file_factory.call(resp.body["file"])
+      end
+
+      # Deletes given files
+      #
+      # @param file_ids [Array<Integer>] File ids separated by commas. Ex: 1,2,3,4
+      # Returns [true]
+      def delete_files(*file_ids)
+        resp = post '/files/delete', { file_ids: file_ids.join(',') }
+
+        if resp.body["status"] == "OK"
+          true
+        else
+          false
+        end
+      end
+
+      private
+      def file_factory
+        @file_factory ||= Putio::Resource::File.public_method(:new)
+      end
+    end
+  end
+end