ruby-imgur 0.02 → 0.03

data/{README.rdoc → README.md}

@@ -1,20 +1,24 @@
-= imgur
+# imgur
 
 Library to interface with the imgur API.
 
-== Usage
+## Usage
 
-  1. Register your application with imgur at https://api.imgur.com/oauth2/addclient
-  2. Place a file called .imgurrc in your user's $HOME directory with the following contents
-    :client_id: "client_id_from_registering_app"
-    :client_secret: "client_secret_from_registering_app"
-    :account_username: "username_of_imgur_account"
-  3. On first run, you will be presented with a browser window asking you to allow access to your account, do this.
-  4. After approval, you will be prompted to enter both the access_token and refresh_token values, which can be retrieved from the URL of the page you are redirected to
+1. Register your application with imgur at https://api.imgur.com/oauth2/addclient
+2. Place a file called .imgurrc in your user's $HOME directory with the following contents
+  <pre>
+  :client_id: "client_id_from_registering_app"
+  :client_secret: "client_secret_from_registering_app"
+  :account_username: "username_of_imgur_account"
+  </pre>
+3. On first run, you will be presented with a browser window asking you to allow access to your account, do this.
+4. After approval, you will be prompted to enter both the access_token and refresh_token values, which can be retrieved from the URL of the page you are redirected to
 
-Examples:
+### Examples:
 
-  #Get first page of gallery
+#### Get first page of gallery:
+
+  ```ruby
   client = Imgur::Client.new
   client.images.all(resource: "gallery", page: 0)
   -> [
@@ -22,18 +26,25 @@ Examples:
        ...
        [173] #<Imgur::Client::Image:0x7fa55ad4a5b0 attributes={id:"CmIrs",title:"Day officially made",datetime:1355595301,animated:false,width:245,height:176,size:899725,views:21774,bandwidth:19590612150,account_url:"idontwantoliveonthisplanetanymore",link:"http://i.imgur.com/CmIrs.gif",ups:269,downs:6,score:273,is_album:false}>
      ]
+  ```
+
+#### Open image in browser
+
+  ```ruby
+  client = Imgur::Client.new
+  image = client.images.all.first
+  image.open_in_browser
+  ```
 
-== Contributing to imgur
+## Contributing to imgur
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
 * Start a feature/bugfix branch
 * Commit and push until you are happy with your contribution
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2012 Eugene Howe. See LICENSE.txt for
 further details.

data/lib/imgur/client.rb

@@ -7,14 +7,24 @@ class Imgur::Client < Cistern::Service
   collection :images
   request :get_image
   request :get_images
+  request :upload_image
+  request :delete_image
 
   model :album
   collection :albums
   request :get_album
   request :get_albums
 
+  model :account
+  collection :accounts
+  request :get_accounts
+  request :get_account
+
+  model :basic_response
+  collection :basic_responses
+
   class Real
-    attr_accessor :url, :path, :parser, :logger, :config, :authorize_path, :token_path
+    attr_accessor :url, :path, :parser, :logger, :config, :authorize_path, :token_path, :connection
 
     def initialize(options={})
       @config                          = options[:config] || YAML.load_file(File.expand_path("~/.imgurrc")) || YAML.load_file("config/config.yml")
@@ -23,6 +33,7 @@ class Imgur::Client < Cistern::Service
       @url                             = URI.parse(options[:url]  || "https://api.imgur.com")
       @logger                          = options[:logger]         || Logger.new(nil)
       @parser                          = begin; require 'json'; JSON; end
+      @connection                      = RestClient::Resource.new(@url)
     end
 
     def reset!
@@ -48,7 +59,7 @@ class Imgur::Client < Cistern::Service
 
     def request(options={})
       method  = (options[:method] || :get).to_s.downcase
-      path    =  @url.to_s + ("/3#{options[:path]}" || "/3")
+      path    = "/3#{options[:path]}" || "/3"
       query   = options[:query] || {}
       unless @config[:access_token]
         Launchy.open(@url.to_s + @authorize_path + "?client_id=#{@config[:client_id]}&response_type=token")
@@ -57,6 +68,7 @@ class Imgur::Client < Cistern::Service
         puts "Copy and paste refresh_token from URL here"
         refresh_token = $stdin.gets.strip
         @config[:access_token] = verifier
+        @config[:refresh_token] = refresh_token
         File.open(File.expand_path("~/.imgurrc"), 'w') { |f| YAML.dump(@config, f) }
       end
       headers = {
@@ -64,20 +76,22 @@ class Imgur::Client < Cistern::Service
         "Authorization" => "Bearer #{@config[:access_token]}",
       }.merge(options[:headers] || {})
 
-      request_body = if body        = options[:body]
-                       json_body    = parser.dump(body)
-                       headers      = {
-                         "Content-Type"   => "application/json, charset=utf-8",
-                         "Content-Length" => json_body.size.to_s,
-                       }.merge(options[:headers] || {})
-
-                       json_body
+      request_body = if body = options[:body]
+                       headers.merge!("Content-Type" => "application/json, charset=utf-8", "Content-Length" => body.to_s.size.to_s,)
+                       body
                      end
       request_body ||= options[:params] || {}
       path           = "#{path}?#{query.map{|k,v| "#{URI.escape(k.to_s)}=#{URI.escape(v.to_s)}"}.join("&")}" unless query.empty?
       begin
-        response = RestClient.send(method, path, headers)
-      rescue RestClient::Forbidden
+        response = case method
+                   when "get"
+                     @connection[path].get(headers)
+                   when "post"
+                     @connection[path].post(request_body, headers)
+                   when "delete"
+                     @connection[path].delete(headers)
+                   end
+      rescue RestClient::Forbidden => e
         self.refresh_token
         retry
       end
@@ -85,6 +99,14 @@ class Imgur::Client < Cistern::Service
       status         = parsed_body.delete("status")
       Imgur::Response.new(status, {}, parsed_body).raise!
     end
+
+    def credits
+      response = request(
+        method: :get,
+        path: "/credits"
+      ).body["data"]
+      "#{response["UserRemaining"]}/#{response["UserLimit"]}"
+    end
   end
 
   class Mock

data/lib/imgur/models/account.rb

@@ -6,7 +6,22 @@ class Imgur::Client::Account < Imgur::Model
   attribute :reputation, type: :float
   attribute :created,    type: :integer
 
-  def open_in_browser
-    Launchy.open(link)
+  def images
+    data = []
+    image_array = []
+    page = 0
+    until data.count > 0 && data.count != 50
+      path = "/account/me/images/#{page}"
+      data = connection.get_images(path: path).body["data"]
+      data.each { |i| image_array << i }
+      page += 1
+    end
+    connection.images.load(image_array)
+  end
+
+  def albums
+    path = "/account/me/albums"
+    data = connection.get_albums(path: path).body["data"]
+    connection.albums.load(data)
   end
 end

data/lib/imgur/models/accounts.rb

@@ -0,0 +1,19 @@
+class Imgur::Client::Accounts < Cistern::Collection
+  include Imgur::PagedCollection
+  include Imgur::Collection
+
+  model Imgur::Client::Account
+
+  model_root "data"
+  model_request :get_account
+
+  collection_root "data"
+  collection_request :get_accounts
+
+  def all(options={})
+    path = "/account/me"
+
+    data = connection.get_accounts(path: path).body["data"]
+    connection.accounts.load([data])
+  end
+end

data/lib/imgur/models/basic_response.rb

@@ -0,0 +1,5 @@
+class Imgur::Client::BasicResponse < Imgur::Model
+  attribute :data
+  attribute :success, type: :boolean
+  attribute :status,  type: :integer
+end

data/lib/imgur/models/basic_responses.rb

@@ -0,0 +1,13 @@
+class Imgur::Client::BasicResponses < Cistern::Collection
+  include Imgur::PagedCollection
+  include Imgur::Collection
+
+  model Imgur::Client::BasicResponse
+
+  model_root "data"
+  model_request :get_basic_response
+
+  collection_root "data"
+  collection_request :get_basic_responses
+
+end

data/lib/imgur/models/image.rb

@@ -16,8 +16,14 @@ class Imgur::Client::Image < Imgur::Model
   attribute :downs,                  type: :integer
   attribute :score,                  type: :integer
   attribute :is_album,               type: :boolean
+  attribute :deletehash
 
   def open_in_browser
     Launchy.open(link)
   end
+
+  def delete
+    data = connection.delete_image(deletehash).body
+    connection.basic_responses.new(data)
+  end
 end

data/lib/imgur/models/images.rb

@@ -24,4 +24,18 @@ class Imgur::Client::Images < Cistern::Collection
     data = connection.get_images(path: path).body["data"]
     connection.images.load(data)
   end
+
+  def upload(options={})
+    raise ArgumentError, ":image is missing: File name or URL requrired" unless options[:image]
+    options[:image] = case options[:image]
+                      when /^(http|ftp)/
+                        options[:image]
+                      when /\.(jp(e)?g|gif|bmp|png|tif(f)?)$/i
+                        File.open(options[:image], 'rb')
+                      else
+                        raise ArgumentError, "Invalid image value"
+                      end
+    data = connection.upload_image(options).body["data"]
+    connection.images.new(data)
+  end
 end

data/lib/imgur/requests/delete_image.rb

@@ -0,0 +1,12 @@
+class Imgur::Client
+  class Real
+    def delete_image(deletehash)
+      path = "/image/#{deletehash}"
+
+      request(
+        :method => :delete,
+        :path   => path,
+      )
+    end
+  end
+end

data/lib/imgur/requests/get_account.rb

@@ -0,0 +1,12 @@
+class Imgur::Client
+  class Real
+    def get_account(id)
+      path = "/#{id}"
+
+      request(
+        :method => :get,
+        :path   => path,
+      )
+    end
+  end
+end

data/lib/imgur/requests/get_accounts.rb

@@ -0,0 +1,11 @@
+class Imgur::Client
+  class Real
+    def get_accounts(params={})
+      path = params[:path]
+      request(
+        :method => :get,
+        :path   => path,
+      )
+    end
+  end
+end

data/lib/imgur/requests/get_albums.rb

@@ -1,6 +1,11 @@
 class Imgur::Client
   class Real
     def get_albums(params={})
+      path = params[:path]
+      request(
+        method: :get,
+        path:   path,
+      )
     end
   end
 end

data/lib/imgur/requests/get_image.rb

@@ -1,7 +1,7 @@
 class Imgur::Client
   class Real
     def get_image(id)
-      path = "/#{id}"
+      path = "/image/#{id["id"]}"
 
       request(
         :method => :get,

data/lib/imgur/requests/upload_image.rb

@@ -0,0 +1,13 @@
+class Imgur::Client
+  class Real
+    def upload_image(options)
+      path = "/upload"
+
+      request(
+        :method => :post,
+        :path   => path,
+        :body   => options,
+      )
+    end
+  end
+end

data/lib/imgur/version.rb

@@ -1,3 +1,3 @@
 module Imgur
-  VERSION = "0.02"
+  VERSION = "0.03"
 end

data/spec/accounts_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe "accounts" do
+  let(:client) { create_client }
+
+  it "should have images" do
+    account = client.accounts.all.first
+    images = account.images
+    images.should_not be_empty
+    images.first.should be_a_kind_of(Imgur::Client::Image)
+  end
+
+  it "should have albums" do
+    account = client.accounts.all.first
+    albums  = account.albums
+    albums.should_not be_empty
+    albums.first.should be_a_kind_of(Imgur::Client::Album)
+
+    album = albums.select { |a| a.privacy == "public" }.last
+    album_images = album.images
+    album_images.should_not be_empty
+    album_images.first.should be_a_kind_of(Imgur::Client::Image)
+  end
+end

data/spec/clients_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe "clients" do
+  let (:client) { create_client }
+  it "should have credits" do
+    client.credits.should_not be_nil
+    pending if client.credits == "0/1000"
+  end
+end

data/spec/images_spec.rb

@@ -8,4 +8,22 @@ describe "images" do
     images.should_not be_empty
     images.first.should be_a_kind_of(Imgur::Client::Image)
   end
+
+  it "should upload an image from filesystem" do
+    image = File.expand_path("spec/support/ruby_logo.jpg")
+    response = client.images.upload(image: image, title: "ruby_logo_jpg")
+    response.should be_a_kind_of(Imgur::Client::Image)
+
+    response = response.delete
+    response.should be_a_kind_of(Imgur::Client::BasicResponse)
+  end
+
+  it "should upload an image from the internet" do
+    image = "http://www.ruby-lang.org/images/logo.gif"
+    response = client.images.upload(image: image, title: "ruby_logo_gif")
+    response.should be_a_kind_of(Imgur::Client::Image)
+
+    response = response.delete
+    response.should be_a_kind_of(Imgur::Client::BasicResponse)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-imgur
 version: !ruby/object:Gem::Version
-  version: '0.02'
+  version: '0.03'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-16 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -103,7 +103,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - imgur.gemspec
 - lib/imgur.rb
@@ -112,21 +112,31 @@ files:
 - lib/imgur/logger.rb
 - lib/imgur/model.rb
 - lib/imgur/models/account.rb
+- lib/imgur/models/accounts.rb
 - lib/imgur/models/album.rb
 - lib/imgur/models/albums.rb
+- lib/imgur/models/basic_response.rb
+- lib/imgur/models/basic_responses.rb
 - lib/imgur/models/comment.rb
 - lib/imgur/models/image.rb
 - lib/imgur/models/images.rb
 - lib/imgur/paged_collection.rb
+- lib/imgur/requests/delete_image.rb
+- lib/imgur/requests/get_account.rb
+- lib/imgur/requests/get_accounts.rb
 - lib/imgur/requests/get_album.rb
 - lib/imgur/requests/get_albums.rb
 - lib/imgur/requests/get_image.rb
 - lib/imgur/requests/get_images.rb
+- lib/imgur/requests/upload_image.rb
 - lib/imgur/response.rb
 - lib/imgur/version.rb
+- spec/accounts_spec.rb
+- spec/clients_spec.rb
 - spec/images_spec.rb
 - spec/spec_helper.rb
 - spec/support/client.rb
+- spec/support/ruby_logo.jpg
 homepage: http://github.com/ehowe/ruby-imgur.git
 licenses: []
 post_install_message: 
@@ -152,7 +162,10 @@ signing_key:
 specification_version: 3
 summary: ''
 test_files:
+- spec/accounts_spec.rb
+- spec/clients_spec.rb
 - spec/images_spec.rb
 - spec/spec_helper.rb
 - spec/support/client.rb
+- spec/support/ruby_logo.jpg
 has_rdoc: