putio-ruby 0.1.1 → 0.2.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODNiNWNkNjIxZWI1NmY3ZWEyMmQzNDhlNDVjNGMwNmZkNDFmMjdjMA==
+    MDNmOGQ5YjQwNzAwNTAxOTg0OWY0OGE3NTE2NWViNGNlNTcyYzg5MA==
   data.tar.gz: !binary |-
-    MTI4MDUxOTgxN2JkYTFmOTE0ODlkNDY5NGJjZWNhYWI2ODIwODUzMw==
+    M2ZmM2Q2ZmU5MzVmMGQ1MDE5ODMzMGM1ZmQxMGM4ZGQ4MDQ1NTdmNA==
 SHA512:
   metadata.gz: !binary |-
-    OTRhZDE3MWY3YTJhMmRmMjU4NWMyODBhNjkxNjUyYWRiMjk4NTU1YmU3NWRm
-    OTBjYzA0ZmVlYzUwZTcxMDJkMzZkYmM5Y2U1YTlhNTBlMTA3OTRlMTA0Yjgx
-    YjFlYTc1YjJjMDU0ZDJhODk1NjNjMDVlOTE5YTAyM2ZiOTM5NmU=
+    YjdhZTZjZThkYmNhNmMxMmNhZjI2MWYyMzc2NzI2ZmY4ZGU4Y2FjYTc0MDM2
+    MWFjYTg2MTJiMzkwNWUxOTlmOWYwMGM5MGZmNjRmNTVkNDIxZTJiZTcyMjRk
+    MWEzMzk2ODI2MGViOGQ0NzZjYTg2MzZmNzFiMzc2OGZjZjMyM2M=
   data.tar.gz: !binary |-
-    MzgzNjMyMzUyYTNkOGNlYWUwMTljZDE4ODlhYjJhOWU3ZGM0ZDBhNzE3NjU4
-    NTM1Mjg4Y2Y0MGJmNDAyOTQyODVkOTFjYmUxYmU0YmE2MmQ2ZjM3M2M0ZDM3
-    ODlhZTE5NzcwYzU3MTc0YWZhYWZhZDJiNzdiZTllYjkxZjliNWM=
+    ZWQxYmFjNDNkNjcyN2U2ZmU5Mjg4YWM0NDBmNThlYjEyMjU1ZDljM2NkYzQy
+    NzdjNjdlY2NiNWM5YjY3MjgzYjdjOGVmMTU3ODc1ZGQwNzZiN2JlMTkyZWJl
+    MWYyZmYxMDVkZjk4M2EzMmRjMmRiNGNmMjlmMzdhYzljY2Y3M2M=

data/README.md

@@ -12,7 +12,7 @@ putio-ruby is a simple gem for communicating with the Put.io REST API. Currently
 
 Add the gem to your Gemfile:
 
-```
+```ruby
 gem 'putio-ruby'
 ```
 
@@ -28,15 +28,21 @@ Or install it yourself as:
 
 First configure the gem to use your oauth token (See [instructions](https://put.io/v2/docs/gettingstarted.html#sign-up) for generating a token)
 
-	Putio.configure :oauth_token => YOUR_OAUTH_TOKEN
-	
+```ruby
+Putio.configure do |config|
+  oauth_token = "YOUR_OAUTH_TOKEN"
+end
+```
+
 Then use it to query Put.io
 
-	Putio::File.list
-	Putio::File.get(1234)
-	Putio::File.get(1234).delete
-	Putio::File.get(1234).download_url
-	
-	Putio::Transfer.list
-	Putio::Transfer.get(1234)
-	Putio::Transfer.add("http://some_url.com")
+```ruby
+Putio::File.list
+file = Putio::File.get(1234)
+file.download_url
+file.delete
+
+Putio::Transfer.list
+Putio::Transfer.get(1234)
+Putio::Transfer.add("http://some_url.com")
+```

data/bin/console

@@ -1,14 +1,10 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "putio/ruby"
+require "putio-ruby"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+require "pry"
+Pry.start

data/lib/putio-ruby.rb

@@ -2,12 +2,14 @@ require "putio-ruby/version"
 
 require "multi_json"
 require "faraday"
-require "active_support"
-require "active_support/inflector"
-require "active_support/core_ext/hash"
+require "faraday_middleware"
+require "virtus"
 
-require "putio-ruby/middleware/parse"
+require "putio-ruby/configuration"
+
+require "putio-ruby/middleware/parse_root"
 require "putio-ruby/middleware/oauth_token"
+require "putio-ruby/middleware/error_handler"
 
 require "putio-ruby/api/client"
 require "putio-ruby/api/object"
@@ -15,15 +17,23 @@ require "putio-ruby/api/object"
 require "putio-ruby/file"
 require "putio-ruby/transfer"
 
-require "putio-ruby/errors"
+require "putio-ruby/error"
 
 module Putio
-  def self.configure(args)
-    @oauth_token = args[:oauth_token]
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
   end
 
-  def self.oauth_token
-    @oauth_token
+  def self.configure
+    yield(configuration)
   end
 end
 

data/lib/putio-ruby/api/client.rb

@@ -2,13 +2,17 @@ module Putio
   module Api
     module Client
       def client
-        @client ||= Faraday.new :url => "https://api.put.io/v2/" do |connection|
+        Faraday.new :url => "https://api.put.io/v2/" do |connection|
           # Request
-          connection.use Putio::Middleware::OauthToken
           connection.request :url_encoded
+          connection.use Putio::Middleware::OauthToken
 
           # Response
-          connection.use Putio::Middleware::Parse
+          connection.use Putio::Middleware::ParseRoot
+          connection.use Putio::Middleware::ErrorHandler
+          connection.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
+
+          # Adapter
           connection.adapter :net_http
         end
       end

data/lib/putio-ruby/api/object.rb

@@ -1,45 +1,12 @@
 module Putio
   module Api
     class Object
+      include Virtus.model
       extend Putio::Api::Client
 
-      def self.plural_name
-        singular_name.pluralize
-      end
-
-      def self.singular_name
-        self.name.demodulize.underscore.downcase
-      end
-
-      def self.parse_collection(hash)
-        objects = hash[plural_name.to_sym]
-        objects.map do |obj|
-          instantiate_object obj
-        end
-      end
-
-      def self.parse_object(hash)
-        object = hash[singular_name.to_sym]
-        instantiate_object object
-      end
-
-      def self.instantiate_object(hash)
-        obj = self.new
-        hash.each do |k,v|
-          obj.set_attribute(k.to_s, v)
-        end
-        obj
-      end
-
       def client
         self.class.client
       end
-
-      def set_attribute(attr, value)
-        return unless attr.present?
-        self.singleton_class.instance_eval { attr_reader "#{attr}".to_sym }
-        self.instance_variable_set("@#{attr}", value)
-      end
     end
   end
 end

data/lib/putio-ruby/configuration.rb

@@ -0,0 +1,5 @@
+module Putio
+  class Configuration
+    attr_accessor :oauth_token
+  end
+end

data/lib/putio-ruby/error.rb

@@ -0,0 +1,62 @@
+module Putio
+  class Error < StandardError
+    def self.from_env(env)
+      status = env.status
+
+      if klass = case status
+                 when 400..499  then Putio::BadRequest
+                 when 500..599  then Putio::ServerError
+                 end
+        klass.new(env)
+      end
+    end
+
+    def initialize(env=nil)
+      @env = env
+      super(build_error_message)
+    end
+
+    def response_error
+      if response_body && error_type && error_message
+        "#{error_type}: #{error_message}"
+      elsif response_body && error_message
+        error_message
+      else
+        response_body
+      end
+    end
+
+    def build_error_message
+      return nil if @env.nil?
+
+      message =  "#{@env.method.to_s.upcase} "
+      message << "#{@env.status} - #{@env.url}\n"
+      message << "#{response_error}" unless response_error.nil?
+      message
+    end
+
+    def response_headers
+      @env.response_headers
+    end
+
+    def response_status
+      @env.status
+    end
+
+    def response_body
+      @env.body
+    end
+
+    def error_type
+      @env.body["error_type"]
+    end
+
+    def error_message
+      @env.body["error_message"]
+    end
+  end
+
+  class BadRequest < Error; end
+  class ServerError < Error; end
+  class ApplicationCredentialsRequired < StandardError; end
+end

data/lib/putio-ruby/file.rb

@@ -1,18 +1,30 @@
 module Putio
   class File < Putio::Api::Object
+    attribute :content_type,       String
+    attribute :crc32,              String
+    attribute :created_at,         DateTime
+    attribute :first_accessed_at,  DateTime
+    attribute :icon,               String
+    attribute :id,                 Integer
+    attribute :is_mp4_available,   Boolean
+    attribute :is_shared,          Boolean
+    attribute :name,               String
+    attribute :opensubtitles_hash, String
+    attribute :parent_id,          Integer
+    attribute :screenshot,         String
+    attribute :size,               Integer
+
     def self.list(parent_id=nil)
       res = client.get "files/list", ( parent_id ? {:parent_id => parent_id} : nil )
-      parse_collection res.body if res.success?
+      res.body.map { |f| self.new f }
     end
 
-    def self.get(id)
-      res = client.get "files/#{id}"
-      parse_object res.body if res.success?
+    def self.file(id)
+      self.new client.get("files/#{id}").body
     end
 
     def download_url
-      res = client.get "files/#{id}/download"
-      res.headers[:location] if res.success?
+      client.get("files/#{id}/download").env.response_headers["location"]
     end
 
     def delete

data/lib/putio-ruby/middleware/error_handler.rb

@@ -0,0 +1,9 @@
+module Putio
+  module Middleware
+    class ErrorHandler < Faraday::Response::Middleware
+      def on_complete(env)
+        raise Putio::Error.from_env(env) if env.status >= 400
+      end
+    end
+  end
+end

data/lib/putio-ruby/middleware/oauth_token.rb

@@ -2,8 +2,8 @@ module Putio
   module Middleware
     class OauthToken < Faraday::Response::Middleware
       def call(env)
-        raise Putio::Errors::AuthorizationError, "No OAuth token provided" unless Putio.oauth_token
-        oauth_string = "oauth_token=#{Putio.oauth_token}"
+        raise Putio::ApplicationCredentialsRequired, "No OAuth token provided" unless Putio.configuration.oauth_token
+        oauth_string = "oauth_token=#{Putio.configuration.oauth_token}"
         query = env[:url].query
         env[:url].query = query ? "#{query}&#{oauth_string}" : oauth_string
         @app.call(env)

data/lib/putio-ruby/middleware/parse_root.rb

@@ -0,0 +1,15 @@
+module Putio
+  module Middleware
+    class ParseRoot < Faraday::Response::Middleware
+      def on_complete(env)
+        plural = env.url.to_s.match(/api\.put\.io\/v2\/(\w+)\//)[1]
+        singular = plural[0..-2]
+        if env[:body][plural]
+          env[:body] = env[:body][plural]
+        elsif env[:body][singular]
+          env[:body] = env[:body][singular]
+        end
+      end
+    end
+  end
+end

data/lib/putio-ruby/transfer.rb

@@ -1,22 +1,48 @@
 module Putio
   class Transfer < Putio::Api::Object
+    attribute :callback_url,         String
+    attribute :created_at,           DateTime
+    attribute :current_ratio,        Float
+    attribute :down_speed,           Integer
+    attribute :downloaded,           Integer
+    attribute :error_message,        String
+    attribute :estimated_time,       Integer
+    attribute :extract,              Boolean
+    attribute :file_id,              Integer
+    attribute :finished_at,          DateTime
+    attribute :id,                   Integer
+    attribute :is_private,           Boolean
+    attribute :name,                 String
+    attribute :peers_connected,      Integer
+    attribute :peers_sending_to_us,  Integer
+    attribute :percent_done,         Integer
+    attribute :save_parent_id,       Integer
+    attribute :seconds_seeding,      Integer
+    attribute :size,                 Integer
+    attribute :source,               String
+    attribute :status,               String
+    attribute :status_message,       String
+    attribute :subscription_id,      Integer
+    attribute :tracker_message,      String
+    attribute :type,                 String
+    attribute :up_speed,             Integer
+    attribute :uploaded,             Integer
+
     def self.list
-      res = client.get "transfers/list"
-      parse_collection res.body if res.success?
+      res = client.get("transfers/list")
+      res.body.map { |t| self.new t }
     end
 
-    def self.get(id)
-      res = client.get "transfers/#{id}"
-      parse_object res.body if res.success?
+    def self.transfer(id)
+      self.new client.get("transfers/#{id}").body
     end
 
     def self.add(url)
-      res = client.post "transfers/add", :url => url
-      parse_object res.body
+      self.new client.post("transfers/add", :url => url).body
     end
 
     def fetch
-      self.class.find(id)
+      self.class.transfer(id)
     end
   end
 end

data/lib/putio-ruby/version.rb

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

data/putio-ruby.gemspec

@@ -22,9 +22,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.0"
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
 
   spec.add_runtime_dependency "faraday", "~> 0.9"
-  spec.add_runtime_dependency "activesupport", ">= 3.0.0", "<= 4.3.0"
+  spec.add_runtime_dependency "faraday_middleware", "~> 0.10"
   spec.add_runtime_dependency "multi_json", "~> 1.7"
+  spec.add_runtime_dependency "virtus", "~> 1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: putio-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Brandon Bloxsom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -95,25 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - <=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - <=
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 4.3.0
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +136,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: A simple library for communicating with the Put.io REST API
 email:
 - bloxsom@umich.edu
@@ -146,10 +168,12 @@ files:
 - lib/putio-ruby.rb
 - lib/putio-ruby/api/client.rb
 - lib/putio-ruby/api/object.rb
-- lib/putio-ruby/errors.rb
+- lib/putio-ruby/configuration.rb
+- lib/putio-ruby/error.rb
 - lib/putio-ruby/file.rb
+- lib/putio-ruby/middleware/error_handler.rb
 - lib/putio-ruby/middleware/oauth_token.rb
-- lib/putio-ruby/middleware/parse.rb
+- lib/putio-ruby/middleware/parse_root.rb
 - lib/putio-ruby/transfer.rb
 - lib/putio-ruby/version.rb
 - putio-ruby.gemspec

data/lib/putio-ruby/errors.rb

@@ -1,6 +0,0 @@
-module Putio
-  module Errors
-    class AuthorizationError < StandardError
-    end
-  end
-end

data/lib/putio-ruby/middleware/parse.rb

@@ -1,17 +0,0 @@
-module Putio
-  module Middleware
-    class Parse < Faraday::Response::Middleware
-      def parse(body)
-        begin
-          return MultiJson.load(body, :symbolize_keys => true)
-        rescue MultiJson::ParseError
-          return body
-        end
-      end
-
-      def on_complete(env)
-        env[:body] = parse(env[:body])
-      end
-    end
-  end
-end