imgurapi 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 264b754ad1bbbc5beae5b00bc28280502866d7b0
-  data.tar.gz: f63f1d965d99acbe5512cebd6b44345d4c66f6bd
+  metadata.gz: cff8c35e8361a8f17f30d62cf865c9dfc12dbbc2
+  data.tar.gz: a6612b4296b9ec7a33418c382cd80684cd78bab9
 SHA512:
-  metadata.gz: 8d58037624698e6c5fca78b770d2a17edc4d9911a57013710727ee1ca960e7f856fca25105b127576f441981b82580a8eebfe96ed8eb1161fe7f607dc1cca48c
-  data.tar.gz: 337e0d31f5ee6e004a82fb489f738fe7a632e9fca3d7eca07da613458a70259f3e0040af844fca1b18dc405168a57c0f4c0ee07148c7a4aa39884ece52c7d282
+  metadata.gz: e89da47ea0da8ba5c26db3a2adf7403184325dbd8dbaa9ef22050a05b590d4920c6766650e23a76d373bd48f5e5057d0e95c797fc6a7d5eea33abb832df35a83
+  data.tar.gz: c98fcd1d38fe797f5bb0f63f8a9b8c1834b81e5e919751caf24c03f9d1e8ce4549f67d933beea88aec40c779d75fdd9e13d98e15852e8900efd48f782ca22480

data/README.md

@@ -46,7 +46,7 @@ Copy the credentials shown as JSON or YAML, depending how you're going to use th
 
 Create a session object to communicate to Imgur.
 ```ruby
-imgur_session = Imgurapi::Session.new(client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET', refresh_token: 'REFRESH_TOKEN')
+imgur_session = Imgurapi::Session.instance(client_id: 'CLIENT_ID', client_secret: 'CLIENT_SECRET', refresh_token: 'REFRESH_TOKEN')
 ```
 
 Your account:
@@ -60,9 +60,13 @@ How many images you have:
 puts imgur_session.account.image_count
 ```
 
-Upload your first image. Argument can be either a String or a File:
+Upload your first image. Argument can either be a path to a file, a File or a link:
 ```ruby
 image = imgur_session.image.image_upload('portrait.jpg')
+# or
+image = imgur_session.image.image_upload(portrait_file)
+# or
+image = imgur_session.image.image_upload('http://domain.tld/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):
@@ -115,6 +119,7 @@ imgur_session.image.image_delete('xyzzy')
 It will return true if succeeded, false otherwise.
 
 ## Available endpoints
+
 Not all the endpoints available at https://api.imgur.com/ have been implemented.
 Feel free to suggest or pull request your needs.
 
@@ -129,3 +134,15 @@ Although I consider this is clearer, in the future it may change to follow the n
 | Image | image.image | https://api.imgur.com/endpoints/image#image |
 | Image | image.image_upload | https://api.imgur.com/endpoints/image#image-upload |
 | Image | image.image_delete | https://api.imgur.com/endpoints/image#image-delete |
+
+## Accessing more than one account at once
+
+Imgur's ACCESS_TOKEN expires after 1 month. When you make an API request, if the ACCESS_TOKEN is invalid, the library will attempt to get a new one via the REFRESH_TOKEN. This new ACCESS_TOKEN will live with the instance of the library, if you instantiated the Imgurapi::Session with `.new`. So if you instantiate a new session, the token will be requested again.
+
+Given requesting a new ACCESS_TOKEN on every API call is slow, the recommended way of using Imgurapi::Session is via `.instance`, not `.new` so it requests a fresh ACCESS_TOKEN only once, which will be stored at class level, reducing optimally the number of token requests.
+
+This approach is not feasible if you want to handle several Imgur accounts at once.
+
+In short:
+ - instantiate Imgurapi::Session via `.instance` if you manage 1 account
+ - instantiate Imgurapi::Session via `.new` if you manage 2 or more accounts

data/lib/imgurapi.rb

@@ -9,6 +9,7 @@ require 'imgurapi/api/base'
 require 'imgurapi/api/account'
 require 'imgurapi/api/image'
 require 'imgurapi/communication'
+require 'imgurapi/file_type'
 require 'imgurapi/session'
 require 'imgurapi/models/base'
 require 'imgurapi/models/account'

data/lib/imgurapi/api/image.rb

@@ -11,15 +11,19 @@ module Imgurapi
 
       # https://api.imgur.com/endpoints/image#image-upload
       def image_upload(local_file)
-        if local_file.is_a?(String)
-          file = File.open(local_file, 'rb')
-        elsif local_file.respond_to? :read
-          file = local_file
-        else
-          raise 'Must provide a File or file path'
-        end
+        file_type = FileType.new(local_file)
+
+        image = if file_type.url?
+                  local_file
+                else
+                  raise 'File must be an image' unless file_type.image?
+
+                  file = local_file.respond_to?(:read) ? local_file : File.open(local_file, 'rb')
+
+                  Base64.encode64(file.read)
+                end
 
-        Imgurapi::Image.new communication.call(:post, 'image', image: Base64.encode64(file.read))
+        Imgurapi::Image.new communication.call(:post, 'image', image: image)
       end
 
       # https://api.imgur.com/endpoints/image#image-delete

data/lib/imgurapi/communication.rb

@@ -24,13 +24,17 @@ module Imgurapi
       case response.status
       when 200, 404
         return parse_message(response.body)['data']
-      when 401, 500
+      when 400
+        raise 'Payload is not an image or recognized by Imgur'
+      when 401
         error_message = parse_message response.body
         raise "Unauthorized: #{error_message['error']['message']}"
       when 403
         get_new_and_reset_token
 
         request attempt + 1, &block # and retry the request once more
+      when 500
+        raise 'Imgur internal error'
       else
         raise "Response code #{response.status} not recognized"
       end

data/lib/imgurapi/file_type.rb

@@ -0,0 +1,34 @@
+module Imgurapi
+  class FileType
+
+    GIF = /^GIF8/
+    PNG = Regexp.new("^\x89PNG".force_encoding('binary'))
+    JPG = Regexp.new("^\xff\xd8\xff\xe0\x00\x10JFIF".force_encoding('binary'))
+    JPG2 = Regexp.new("^\xff\xd8\xff\xe1(.*){2}Exif".force_encoding('binary'))
+
+    def initialize(path)
+      @path = path
+    end
+
+    def mime_type
+      case IO.read(@path, 10)
+      when GIF
+        'image/gif'
+      when PNG
+        'image/png'
+      when JPG
+        'image/jpeg'
+      when JPG2
+        'image/jpeg'
+      end
+    end
+
+    def image?
+      !!mime_type
+    end
+
+    def url?
+      !!(@path =~ %r(^(http://|https://|ftp://)))
+    end
+  end
+end

data/lib/imgurapi/version.rb

@@ -1,5 +1,5 @@
 module Imgurapi
 
-  VERSION = '3.0.2'
+  VERSION = '3.1.0'
 
 end

data/spec/imgurapi/api/image_spec.rb

@@ -4,7 +4,6 @@ require 'imgurapi'
 describe Imgurapi::Api::Image do
 
   before :all do
-    credentials = read_credentials_file
     @session = Imgurapi::Session.new(credentials)
   end
 

data/spec/imgurapi/file_type_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'imgurapi'
+
+describe Imgurapi::FileType do
+
+  describe '#mime_type' do
+    it 'returns the right types' do
+      expect(described_class.new('sample.gif').mime_type).to eq 'image/gif'
+      expect(described_class.new('sample.png').mime_type).to eq 'image/png'
+      expect(described_class.new('sample.jpg').mime_type).to eq 'image/jpeg'
+      expect(described_class.new('sample.jpg2').mime_type).to eq 'image/jpeg'
+      expect(described_class.new('sample.txt').mime_type).to be_nil
+    end
+  end
+
+  describe '#image?' do
+    it 'returns true for images' do
+      expect(described_class.new('sample.jpg').image?).to be true
+    end
+
+    it 'returns false for anything else' do
+      expect(described_class.new('sample.txt').image?).to be false
+    end
+  end
+
+
+  describe '#url?' do
+    it 'returns true for a valid URL' do
+      expect(described_class.new('http://domain.tld/sample.jpg').url?).to be true
+      expect(described_class.new('https://domain.tld/sample.jpg').url?).to be true
+      expect(described_class.new('ftp://domain.tld/sample.jpg').url?).to be true
+    end
+
+    it 'returns false for anything else' do
+      expect(described_class.new('smb://sample.txt').url?).to be false
+      expect(described_class.new('sample.txt').url?).to be false
+    end
+  end
+end

data/spec/imgurapi_spec.rb

@@ -4,23 +4,29 @@ 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
+    session = Imgurapi::Session.new(credentials)
 
-    # Upload image
-    image = @session.image.image_upload(@upload_path)
+    # Upload image via path
+    image = session.image.image_upload('sample.jpg')
+
+    # Upload image via file
+    image2 = session.image.image_upload(File.open('sample.jpg', 'r'))
+
+    # Upload image via link
+    image3 = session.image.image_upload('http://www.nationalcrimesyndicate.com/wp-content/uploads/2014/02/Ace.jpg')
 
     # It is there
-    expect(@session.account.image_count).to be > 0
+    expect(session.account.image_count).to be > 0
 
     # Retrieve same image
-    retrieved_image = @session.image.image(image.id)
+    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
+    # Delete all images
+    expect(session.image.image_delete(image)).to eq true
+    expect(session.image.image_delete(image2)).to eq true
+    expect(session.image.image_delete(image3)).to eq true
   end
 end

data/spec/spec_helper.rb

@@ -1,30 +1,22 @@
 module EverythingAsExpected
 
-  def read_credentials_file
+  def credentials
     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]
+    credentials_hash = JSON.parse(credentials_file_contents)
+    if credentials_hash.keys.count != 4 and credentials_hash.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.inject({}) do |options, (key, value)|
+    credentials_hash.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
-
 end
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imgurapi
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Daniel Cruz Horts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-12 00:00:00.000000000 Z
+date: 2017-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,7 @@ files:
 - lib/imgurapi/api/base.rb
 - lib/imgurapi/api/image.rb
 - lib/imgurapi/communication.rb
+- lib/imgurapi/file_type.rb
 - lib/imgurapi/models/account.rb
 - lib/imgurapi/models/base.rb
 - lib/imgurapi/models/image.rb
@@ -89,6 +90,7 @@ files:
 - lib/imgurapi/tasks/tasks.rake
 - lib/imgurapi/version.rb
 - spec/imgurapi/api/image_spec.rb
+- spec/imgurapi/file_type_spec.rb
 - spec/imgurapi/models/image_spec.rb
 - spec/imgurapi/session_spec.rb
 - spec/imgurapi_spec.rb
@@ -113,12 +115,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Imgur authenticated API
 test_files:
 - spec/imgurapi/api/image_spec.rb
+- spec/imgurapi/file_type_spec.rb
 - spec/imgurapi/models/image_spec.rb
 - spec/imgurapi/session_spec.rb
 - spec/imgurapi_spec.rb