imgurapi 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d77b29707bea1234b6841d315a016b0b16f955d
-  data.tar.gz: d6b760ffe9a4619495f1856ded2260c14a6309ac
+  metadata.gz: 216926a679fce6cb67109da7246e1d9919cee5f0
+  data.tar.gz: be7432049b038156e42f376c0548c711421ec4c0
 SHA512:
-  metadata.gz: 6b234a644136409006effbc608543020632d2a9065f208f284fd2d5199f98829b47186470ed920c80b0ef95e59063e538e7c6f5083bd67916dff509befb1ebb7
-  data.tar.gz: c6b19d8891c344136ad0de716e39efb4310933dfd94cde38265b7e557227bb8227d64d7fcab81fac0cf49c5fa3ef3f21c4fe1109c87391b6a566e7d9e8403a7b
+  metadata.gz: d1cf1a21fafb97f9d7efdf405814cc388d8e1d6c279c148aac5ec48e07b8d6d2c0a22d3893b1efebd2c5a33e51f335ed232f2773e093a29b20ddd0f550edad8a
+  data.tar.gz: 2bd8f37e2ff26f926d7db086f6eff2a29e19c90203cd98ca8c0f59c171cc107264de063e00be0a8c764906f923144e035bd7a30b105cc75b4c8deeb61d90bd81

data/README.md

@@ -37,12 +37,11 @@ $ rake imgur:authorize CLIENT_ID='CLIENT_ID' CLIENT_SECRET='CLIENT_SECRET'
 Visit this URL: http://api.imgur.com/oauth/authorize?oauth_token=xxx
 And after you approved the authorization please enter your verification code: yyy
 
-Authorization was successful. Use these credentials to initialize the library:
-
-access_token: ACCESS_TOKEN
-refresh_token: REFRESH_TOKEN
+Authorization was successful. These are your credentials to initialize the library:
 ```
 
+Copy the credentials shown as JSON or YAML, depending how you're going to use this library.
+
 ## Usage and overview
 
 Create a session object to communicate to Imgur.
@@ -63,7 +62,7 @@ puts imgur_session.account.image_count
 
 Upload your first image. Argument can be either a String or a File:
 ```ruby
-image = imgur_session.image.image.upload('portrait.jpg')
+image = imgur_session.image.image_upload('portrait.jpg')
 ```
 
 image is now an instance of Imgurapi::Image, a convenient way to manage all the attributes of your image (at least more convenient than a multilevel dictionary):
@@ -71,7 +70,7 @@ image is now an instance of Imgurapi::Image, a convenient way to manage all the
 name = nil
 title = nil
 caption = nil
-hash = "xyzzy"
+id = "xyzzy"
 deletehash = "abcdef"
 datetime = "2012-11-18 16:22:00"
 type = "image/jpeg"
@@ -86,9 +85,9 @@ link = "http://imgur.com/xyzzy"
 
 Do you need to retrieve a previously uploaded image?
 ```ruby
-my_image = imgur_session.image.image('hash_code')
+my_image = imgur_session.image.image('id_code')
 ```
-Granted, another Image object. It will return nil if it could not find an image matching your hash.
+Granted, another Image object. It will error if it could not find an image matching the id.
 
 Feel free to use it in your Rails views:
 ```ruby

data/lib/imgurapi.rb

@@ -3,11 +3,6 @@ require 'faraday'
 require 'json'
 require 'base64'
 
-# Some nice extensions to base classes
-require 'imgurapi/extensions/array'
-require 'imgurapi/extensions/hash'
-require 'imgurapi/extensions/string'
-
 # This gem real code
 require 'imgurapi/version'
 require 'imgurapi/api/base'

data/lib/imgurapi/api/image.rb

@@ -4,14 +4,14 @@ module Imgurapi
 
       # https://api.imgur.com/endpoints/image#image
       def image(id)
-        raise 'Please provide a valid image identificator' if id.nil? or !id.kind_of? String or id == '' or !!(id =~ /[^\w]/)
+        raise 'Please provide a valid image identificator' if id.nil? || !id.is_a?(String) || id == '' || !!(id =~ /[^\w]/)
 
         Imgurapi::Image.new communication.call(:get, "image/#{id}")
       end
 
       # https://api.imgur.com/endpoints/image#image-upload
       def image_upload(local_file)
-        if local_file.kind_of? String
+        if local_file.is_a?(String)
           file = File.open(local_file, 'rb')
         elsif local_file.respond_to? :read
           file = local_file
@@ -28,7 +28,7 @@ module Imgurapi
           id = id.id
         end
 
-        raise 'Please provide a valid image identificator' if id.nil? or !id.kind_of? String or id == '' or !!(id =~ /[^\w]/)
+        raise 'Please provide a valid image identificator' if id.nil? || !id.is_a?(String) || id == '' || !!(id =~ /[^\w]/)
 
         communication.call(:delete, "image/#{id}")
       end

data/lib/imgurapi/models/image.rb

@@ -10,7 +10,7 @@ module Imgurapi
 
     # Provides the download URL in case you know a valid imgur hash and don't want to make a network trip with .find
     # Just in case you don't need the full Imgurapi::Image object
-    def url(size)
+    def url(size = nil)
       size = case size
              when :small_square, :small, :s
                's'

data/lib/imgurapi/tasks/rake.rb

@@ -1,4 +1,5 @@
 require 'imgurapi/session'
+require 'faraday'
 
 module Imgurapi
 
@@ -26,10 +27,23 @@ module Imgurapi
 
       puts <<-MESSAGE
 
-Authorization was successful. Use these credentials to initialize the library:
+Authorization was successful. These are your credentials to initialize the library:
 
+JSON format, for credentials.json:
+
+{
+"client_id": "#{client_id}",
+"client_secret": "#{client_secret}",
+"access_token": "#{credentials['access_token']}",
+"refresh_token": "#{credentials['refresh_token']}"
+}
+
+YAML format, for imgur.yml:
+
+client_id: #{client_id}
+client_secret: #{client_secret}
 access_token: #{credentials['access_token']}
-refresh_secret: #{credentials['refresh_token']}
+refresh_token: #{credentials['refresh_token']}
 
 MESSAGE
     end

data/lib/imgurapi/tasks/tasks.rake

@@ -3,7 +3,7 @@ require 'imgurapi/tasks/rake'
 namespace :imgur do
   desc 'Obtain your Imgur tokens'
   task :authorize do
-    if ENV['CLIENT_ID'].nil? or ENV['CLIENT_SECRET'].nil?
+    if ENV['CLIENT_ID'].nil? || ENV['CLIENT_SECRET'].nil?
       puts "USAGE: `rake imgur:authorize CLIENT_ID=your_client_id CLIENT_SECRET=your_client_secret`"
       exit
     end

data/lib/imgurapi/version.rb

@@ -1,5 +1,5 @@
 module Imgurapi
 
-  VERSION = '3.0.0'
+  VERSION = '3.0.1'
 
 end

data/spec/imgurapi/api/image_spec.rb

@@ -0,0 +1,38 @@
+require_relative '../../spec_helper'
+require 'imgurapi'
+
+describe Imgurapi::Api::Image do
+
+  before :all do
+    credentials = read_credentials_file
+    @session = Imgurapi::Session.new(credentials)
+  end
+
+  describe '#image' do
+    it 'retrieves the image' do
+      expect { @session.image.image(:not_an_image_id) }.to raise_error StandardError
+      expect { @session.image.image('r4ndom 1d') }.to raise_error StandardError
+
+      image = @session.image.image('12345')
+      expect(image.error).to eq 'Unable to find an image with the id, 12345'
+    end
+  end
+
+  describe '#image_upload' do
+    it 'uploads the image' do
+      expect { @session.image.image_upload('') }.to raise_error StandardError
+      expect { @session.image.image_upload(:not_the_expected_object) }.to raise_error StandardError
+    end
+  end
+
+  describe '#image_delete' do
+    it 'deletes the image' do
+      expect { @session.image.image_delete(:not_an_image_id) }.to raise_error StandardError
+      expect { @session.image.image_delete('r4ndom 1d') }.to raise_error StandardError
+
+      #expect(@session.image.image_delete('12345')).to eq true # is 200 when image does not exist?
+
+      expect { @session.image.image_delete('valid_id') }.to raise_exception 'Retried 3 times but could not get an access_token'
+    end
+  end
+end

data/spec/imgurapi/models/image_spec.rb

@@ -0,0 +1,21 @@
+require_relative '../../spec_helper'
+require 'imgurapi'
+
+describe Imgurapi::Image do
+
+  it 'creates an Image with the fields provided' do
+    image = Imgurapi::Image.new(a: 1, b: 2)
+
+    expect(image.a).to eq 1
+    expect(image.b).to eq 2
+  end
+
+  it 'returns a download URL' do
+    image = Imgurapi::Image.new(id: 'hash')
+
+    expect(image.url).to eq "http://i.imgur.com/hash.jpg"
+    expect(image.url(:random_size)).to eq "http://i.imgur.com/hash.jpg"
+    expect(image.url(:small_square)).to eq "http://i.imgur.com/hashs.jpg"
+    expect(image.url(:large_thumbnail)).to eq "http://i.imgur.com/hashl.jpg"
+  end
+end

data/spec/imgurapi/session_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../spec_helper'
+require 'imgurapi'
+
+describe Imgurapi::Session do
+
+  context 'incorrect credentials' do
+    it { expect { described_class.new }.to raise_error ArgumentError }
+    it { expect { described_class.new(random_key: nil) }.to raise_error ArgumentError }
+    it { expect { described_class.new(client_id: nil, random_key: nil) }.to raise_error ArgumentError }
+    it { expect { described_class.new({}) }.to raise_error ArgumentError }
+  end
+
+  context 'correct credentials' do
+    it do
+      expect(
+        described_class.new(client_id: 'ID', client_secret: 'SECRET', refresh_token: 'TOKEN')
+      ).to be_an_instance_of described_class
+    end
+  end
+end

data/spec/imgurapi_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'imgurapi'
+
+describe Imgurapi do
+
+  it 'does an integration test by uploading, retrieving and deleting an image' do
+    credentials = read_credentials_file
+    @session = Imgurapi::Session.new(credentials)
+    @upload_path, @upload_file = my_sample_image
+
+    # Upload image
+    image = @session.image.image_upload(@upload_path)
+
+    # It is there
+    expect(@session.account.image_count).to be > 0
+
+    # Retrieve same image
+    retrieved_image = @session.image.image(image.id)
+
+    # Same, indeed
+    expect(retrieved_image.id).to eq(image.id)
+
+    # Delete image
+    expect(@session.image.image_delete(image)).to eq true
+  end
+end

data/spec/spec_helper.rb

@@ -4,21 +4,24 @@ module EverythingAsExpected
     unless File.exist? 'credentials.json'
       raise "Please add a credentials.json file to the project directory containing your Imgur app_key, app_secret, access_token and access_token_secret. See credentials.json.example to get started."
     end
-    
+
     credentials_file_contents = File.open('credentials.json', 'r').read
     credentials = JSON.parse(credentials_file_contents)
     if credentials.keys.count != 4 and credentials.keys & [:app_key, :app_secret, :access_token, :access_token_secret] != [:app_key, :app_secret, :access_token, :access_token_secret]
       raise "Your credentials.json file does contain all the required information. See credentials.json.example for more help."
     end
-    
-    credentials.symbolize_keys
+
+    credentials.inject({}) do |options, (key, value)|
+      options[key.to_sym] = value
+      options
+    end
   end
 
   def my_sample_image
     unless File.exist? 'sample.jpg'
       raise "Please add a sample.jpg file to the project directory to test upload and download. Recommended size: under 30kB"
     end
-    
+
     ['sample.jpg', File.open('sample.jpg', 'r')]
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imgurapi
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Daniel Cruz Horts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2017-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -66,9 +80,6 @@ files:
 - lib/imgurapi/api/base.rb
 - lib/imgurapi/api/image.rb
 - lib/imgurapi/communication.rb
-- lib/imgurapi/extensions/array.rb
-- lib/imgurapi/extensions/hash.rb
-- lib/imgurapi/extensions/string.rb
 - lib/imgurapi/models/account.rb
 - lib/imgurapi/models/base.rb
 - lib/imgurapi/models/image.rb
@@ -77,8 +88,10 @@ files:
 - lib/imgurapi/tasks/rake.rb
 - lib/imgurapi/tasks/tasks.rake
 - lib/imgurapi/version.rb
-- spec/imgur/session_spec.rb
-- spec/imgur_spec.rb
+- spec/imgurapi/api/image_spec.rb
+- spec/imgurapi/models/image_spec.rb
+- spec/imgurapi/session_spec.rb
+- spec/imgurapi_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/dncrht/imgur
 licenses:
@@ -100,12 +113,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Imgur authenticated API
 test_files:
-- spec/imgur/session_spec.rb
-- spec/imgur_spec.rb
+- spec/imgurapi/api/image_spec.rb
+- spec/imgurapi/models/image_spec.rb
+- spec/imgurapi/session_spec.rb
+- spec/imgurapi_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/imgurapi/extensions/array.rb

@@ -1,9 +0,0 @@
-class Array # :nodoc:
-  def extract_options! # :nodoc:
-    last.is_a?(::Hash) ? pop : {}
-  end unless method_defined?(:extract_options!)
-
-  def to_hash # :nodoc:
-    inject({}) { |hsh, (k,v)| hsh[k] = v  ; hsh }
-  end unless method_defined?(:to_hash)
-end

data/lib/imgurapi/extensions/hash.rb

@@ -1,61 +0,0 @@
-class Hash # :nodoc:
-  def slice(*keys) #:nodoc:
-    keys = keys.map! { |key| convert_key(key) } if respond_to?(:convert_key)
-    hash = self.class.new
-    keys.each { |k| hash[k] = self[k] if has_key?(k) }
-    hash
-  end unless method_defined?(:slice)
-
-  def symbolize_keys # :nodoc:
-    inject({}) do |options, (key, value)|
-      options[(key.to_sym rescue key) || key] = value
-      options
-    end
-  end unless method_defined?(:symbolize_keys)
-
-  def symbolize_keys! # :nodoc:
-    self.replace(self.symbolize_keys)
-  end unless method_defined?(:symbolize_keys!)
-
-  def symbolize_keys_recursively # :nodoc:
-    hsh = symbolize_keys
-    hsh.each { |k, v| hsh[k] = v.symbolize_keys_recursively if v.kind_of?(Hash) }
-    hsh.each { |k, v| hsh[k] = v.map { |i| i.kind_of?(Hash) ? i.symbolize_keys_recursively : i } if v.kind_of?(Array) }
-    return hsh
-  end unless method_defined?(:symbolize_keys_recursively)
-
-  def stringify_keys # :nodoc:
-    inject({}) do |options, (key, value)|
-      options[(key.to_s rescue key) || key] = value
-      options
-    end
-  end unless method_defined?(:stringify_keys)
-
-  def stringify_keys! # :nodoc:
-    self.replace(self.stringify_keys)
-  end unless method_defined?(:stringify_keys!)
-
-  def stringify_keys_recursively # :nodoc:
-    hsh = stringify_keys
-    hsh.each { |k, v| hsh[k] = v.stringify_keys_recursively if v.kind_of?(Hash) }
-    hsh.each { |k, v| hsh[k] = v.map { |i| i.kind_of?(Hash) ? i.stringify_keys_recursively : i } if v.kind_of?(Array) }
-    return hsh
-  end unless method_defined?(:stringify_keys_recursively)
-
-  def to_struct # :nodoc:
-    struct = Struct.new(*keys).new(*values)
-    # attach methods for any predicate keys, since Struct.new doesn't seem to do that
-    pred_keys = slice(*(keys.select { |key| key.to_s.ends_with?('?') }))
-    pred_keys.each do |key, val|
-      struct.eigenclass.send(:define_method, key.to_sym) { return val }
-    end
-    return struct
-  end unless method_defined?(:to_struct)
-
-  def to_struct_recursively # :nodoc:
-    hsh = dup
-    hsh.each { |k, v| hsh[k] = v.to_struct_recursively if v.kind_of?(Hash) }
-    hsh.each { |k, v| hsh[k] = v.map { |i| i.kind_of?(Hash) ? i.to_struct_recursively : i } if v.kind_of?(Array) }
-    return hsh.to_struct
-  end unless method_defined?(:to_struct_recursively)
-end

data/lib/imgurapi/extensions/string.rb

@@ -1,9 +0,0 @@
-class String # :nodoc:
-  def starts_with?(prefix) # :nodoc:
-    self[0, prefix.length] == prefix
-  end unless method_defined?(:starts_with?)
-
-  def ends_with?(suffix) # :nodoc:
-    self[-suffix.length, suffix.length] == suffix
-  end unless method_defined?(:ends_with?)
-end

data/spec/imgur/session_spec.rb

@@ -1,20 +0,0 @@
-require_relative '../spec_helper'
-require 'imgur'
-
-describe Imgurapiapi::Session do
-
-  context 'incorrect credentials' do
-    it { expect { Imgurapi::Session.new }.to raise_error }
-    it { expect { Imgurapi::Session.new(random_key: nil) }.to raise_error }
-    it { expect { Imgurapi::Session.new(client_id: nil, random_key: nil) }.to raise_error }
-    it { expect { Imgurapi::Session.new({}) }.to raise_error }
-  end
-
-  context 'correct credentials' do
-    it do
-      expect(
-        Imgurapi::Session.new(client_id: 'ID', client_secret: 'SECRET', refresh_token: 'TOKEN')
-      ).to be_an_instance_of Imgurapi::Session
-    end
-  end
-end

data/spec/imgur_spec.rb

@@ -1,146 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'imgur'
-
-describe Imgurapi do
-
-  describe 'placeholder classes' do
-
-    it 'should create an Image with the fields provided' do
-      image = Imgurapi::Image.new
-      image.should be_an_instance_of Imgurapi::Image
-
-      fields = {:a => 1, :b => 2}
-      image = Imgurapi::Image.new(fields)
-      image.should be_an_instance_of Imgurapi::Image
-      image.a.should eq(1)
-      image.b.should eq(2)
-    end
-
-    it 'should create a Link with the fields provided' do
-      links = Imgurapi::Links.new
-      links.should be_an_instance_of Imgurapi::Links
-
-      fields = {:a => 1, :b => 2}
-      links = Imgurapi::Links.new(fields)
-      links.should be_an_instance_of Imgurapi::Links
-      links.a.should eq(1)
-      links.b.should eq(2)
-    end
-
-  end
-
-  describe 'api' do
-
-    it 'should return a download URL' do
-      imgur_hash = 'random_valid_hash'
-
-      @session.url(:foo).should eq('')
-      @session.url().should eq('')
-      @session.url(imgur_hash).should eq("http://i.imgur.com/#{imgur_hash}.jpg")
-      @session.url(imgur_hash, :random_size).should eq("http://i.imgur.com/#{imgur_hash}.jpg")
-      @session.url(imgur_hash, :small_square).should eq("http://i.imgur.com/#{imgur_hash}s.jpg")
-      @session.url(imgur_hash, :large_thumbnail).should eq("http://i.imgur.com/#{imgur_hash}l.jpg")
-    end
-
-  end
-
-  describe 'communication' do
-
-    before(:all) do
-      credentials = read_credentials_file
-      @session = Imgurapi::Session.new(credentials)
-    end
-
-    it 'should parse_message' do
-      @session.send(:parse_message, '[]').should eq([])
-      expect { session.send(:parse_message) }.to raise_error
-    end
-
-    it 'should process_message' do
-      Response = Struct.new(:code, :body)
-
-      response = Response.new(200, '[]')
-      @session.send(:process_response, response).should eq([])
-
-      response = Response.new(404, '[]')
-      @session.send(:process_response, response).should eq([])
-
-      response = Response.new(401, '{"error": {"message": "1"}}')
-      expect { @session.send(:process_response, response) }.to raise_error "Unauthorized: 1"
-
-      response = Response.new(500, '{"error": {"message": "1"}}')
-      expect { @session.send(:process_response, response) }.to raise_error "Unauthorized: 1"
-
-      code = rand(999)
-      response = Response.new(code, '')
-      expect { @session.send(:process_response, response) }.to raise_error "Response code #{code} not recognized"
-    end
-
-    it 'should compose_image' do
-      @session.send(:compose_image, {}).should eq(nil)
-      @session.send(:compose_image, {:imags => {:image => {}, :links => {}}}).should eq(nil)
-      @session.send(:compose_image, {:images => {:imae => {}, :links => {}}}).should eq(nil)
-      @session.send(:compose_image, {:images => {:image => {}, :lins => {}}}).should eq(nil)
-      @session.send(:compose_image, {:images => {}}).should eq(nil)
-
-      from_hash = {:images => {:image => {}, :links => {}}}
-      @session.send(:compose_image, from_hash).should be_an_instance_of Imgurapi::Image
-      @session.send(:compose_image, from_hash).links.should be_an_instance_of Imgurapi::Links
-    end
-
-  end
-
-  describe 'image management calls' do
-
-    before(:all) do
-      credentials = read_credentials_file
-      @session = Imgurapi::Session.new(credentials)
-      @upload_path, @upload_file = my_sample_image
-    end
-
-    it 'should return my account information' do
-      @session.account.should be_an_instance_of Hash
-    end
-
-    it 'should return the number of images stored' do
-      @session.images_count.should > 0
-    end
-
-    it 'should upload the image' do
-      expect { @session.upload('') }.to raise_error
-      expect { @session.upload(:not_the_expected_object) }.to raise_error
-
-      @@image_by_path = @session.upload(@upload_path) #FIXME I know this is horrible, but I need to share the same image between tests http://brentlavelle.wordpress.com/2011/04/04/rspec-and-instance-variables/
-      @@image_by_path.should be_an_instance_of Imgurapi::Image
-
-      @@image_by_file = @session.upload(@upload_file)
-      @@image_by_file.should be_an_instance_of Imgurapi::Image
-    end
-
-    it 'should retrieve the image' do
-      expect { @session.find(:not_an_image_hash) }.to raise_error
-      expect { @session.find('r4ndom ha5h') }.to raise_error
-
-      image = @session.find('valid_hash_not_related_to_any_image')
-      image.should be_nil
-
-      image = @session.find(@@image_by_path.hash)
-      image.should be_an_instance_of Imgurapi::Image
-
-      image.hash.should eq(@@image_by_path.hash)
-    end
-
-    it 'should delete the image' do
-      expect { @session.destroy(:not_an_image_hash) }.to raise_error
-      expect { @session.destroy('r4ndom ha5h') }.to raise_error
-
-      @session.destroy('valid_hash_not_related_to_any_image').should be_false
-
-      @session.destroy(@@image_by_path).should be_true #deletes first image
-
-      @session.destroy(@@image_by_file.hash).should be_true #deletes second image
-    end
-
-  end
-
-end