flickrie 0.0.2 → 0.1.0

data/.gitignore

@@ -1,3 +1,4 @@
 TODO.md
 Gemfile.lock
 *.gem
+development.rb

data/Gemfile

@@ -5,4 +5,6 @@ gemspec
 group :development, :test do
   gem "rake"
   gem "activesupport"
+  gem "flickrie", :path => "~/Projects/flickrie"
+  gem "pry"
 end

data/README.md

@@ -2,7 +2,7 @@
 
 ## About
 
-This gem is a nice wrapper for the Flickr API an intuitive interface.
+This gem is a nice wrapper for the Flickr API with an intuitive interface.
 
 The reason why I did this gem is because the other ones either weren't
 well maintained, or they were too literal in the sense that the response from
@@ -22,13 +22,14 @@ Then in your app you require it and set the API key.
 
 ```ruby
 require 'flickrie'
-Flickr.api_key = "some_api_key"
+Flickrie.api_key = "<your_api_key>"
+Flickrie.shared_secret = "<your_shared_secret>"
 ```
 
 Then you can search for photos.
 
 ```ruby
-photos = Flickr.photos_from_set(819234) # => [#<Photo: id="8232348", ...>, #<Photo: id="8194318", ...>, ...]
+photos = Flickrie.photos_from_set(819234) # => [#<Photo: id="8232348", ...>, #<Photo: id="8194318", ...>, ...]
 
 photo = photos.first
 photo.id          # => "8232348"
@@ -38,10 +39,14 @@ photo.owner       # => #<User: nsid="67313352@N04", ...>
 photo.owner.nsid  # => "67313352@N04"
 ```
 
+Note that what Flickr refers to as "photoset" in its documentation, I
+refer to as "set". This is because the word "photoset" would be wrong,
+since sets can also hold videos.
+
 You can also throw in some parameters to get more information about photos.  For example,
 
 ```ruby
-photos = Flickr.photos_from_set(819234, :extras => 'owner_name,last_update,tags,views')
+photos = Flickrie.photos_from_set(819234, :extras => 'owner_name,last_update,tags,views')
 
 photo = photos.first
 photo.tags           # => "cave cold forrest"
@@ -55,14 +60,14 @@ On the list of available parameters you can read in the [Flickr API documentatio
 You can also get additional info on a single photo:
 
 ```ruby
-photo = Flickr.get_photo_info(8232348)
+photo = Flickrie.get_photo_info(8232348)
 
 photo.description           # => "In this photo, Samantha and me found a secret tunnel..."
 photo.comments_count        # => 6
 photo.visibility.public?    # => true
 photo.can_download?         # => true
 photo.owner.real_name       # => "John Smith"
-photo.location.country.name # => "United Stated"
+photo.location.country.name # => "United States"
 ```
 
 You can also get this info on an existing photo:
@@ -76,7 +81,7 @@ photo.description # => "In this photo Peter said something really funny..."
 If you want to display photos from flickr in your app, this is probably the most useful part:
 
 ```ruby
-photo = Flickr.photo_get_sizes(8232348)
+photo = Flickrie.get_photo_sizes(8232348)
 
 photo.medium!(800)
 photo.size       # => "Medium 800"
@@ -91,23 +96,41 @@ photo.width      # => 240
 photo.width      # => 320
 ```
 
-If you want sizes to be available to photos you're fetching from a set, it's a bad idea to call `#get_info` on each photo. Instead, you should pass in these options:
+If you want sizes to be available to photos you're fetching from a set, it's not a good idea to call `#get_sizes` on each photo, because that will make an HTTP request on each photo, which can be very slow. Instead, you should pass in these options:
 
 ```ruby
-photos = Flickr.photos_from_set(1242379, :extras => 'url_sq url_q url_t url_s url_n url_m url_z url_c url_l url_o')
+photos = Flickrie.photos_from_set(1242379, :extras => 'url_sq,url_q,url_t,url_s,url_n,url_m,url_z,url_c,url_l,url_o')
 photo = photos.first
 photo.medium!(640)
 photo.source_url # => "http://farm8.staticflickr.com/7049/6946979188_25bb44852b_z.jpg"
 ```
 
-These are just some of the cool things you can do. To see a full list of available methods, I encourage you to read the [wiki](https://github.com/janko-m/flickrie/wiki). I promise, I will document the methods properly in near future :)
+To see a full list of available methods, I see the [wiki](https://github.com/janko-m/flickrie/wiki). I promise, I will document the methods properly in near future :)
+
+## Authentication
+
+```ruby
+require 'flickrie'
+
+Flickrie.api_key = "<your api key>"
+Flickrie.shared_secret = "<your shared secret>"
+
+url = Flickrie.get_authorization_url
+puts "Visit this url to authorize: #{url}"
+puts "Then enter the code that was displayed: "
+code = gets.strip
+Flickrie.authorize!(code)
+puts "You're all done! Now go make some authenticated requests. Make me proud, son."
+```
+
+When calling `Flickrie.get_authorization_url`, you can also pass in the option `:permissions => "<perms>"`, where instead of `<perms>` you write either `read`, `write` or `delete`.
 
 ## A few words
 
-Now, I covered only a few out of many Flickr's API methods using this approach, but I'll constantly update this gem with new API methods. For all of the methods I didn't cover, you can call them using `Flickr.client`, like this:
+Now, I covered only a few out of many Flickr's API methods using this approach, but I'll constantly update this gem with new API methods. For all of the methods I didn't cover, you can call them using `Flickrie.client`, like this:
 
 ```ruby
-response = Flickr.client.get("flickr.photos.getContext", :photo_id => 2842732)
+response = Flickrie.client.get("flickr.photos.getContext", :photo_id => 2842732)
 reponse.body # =>
 # {
 #   "count" => {"_content" => 99},
@@ -124,13 +147,19 @@ reponse.body # =>
 # }
 ```
 
-It's not nearly as pretty, but at least you can get to the data
+It's not nearly as pretty, but at least you can get to the data.
 
 ## Issues
 
 Please, feel free to post any issues that you're having, I will try to
 help you in any way I can.
 
+## Cedits
+
+Special thanks to @**mislav**, my brother, he helped me really a lot
+with getting started with ruby. And he also helped me with the
+basis of this gem.
+
 ## Currently covered API methods
 
 ### people

data/flickrie.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/flickrie/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Janko Marohnić"]
   gem.email         = ["janko.marohnic@gmail.com"]
-  gem.description   = %q{This gem is a nice wrapper for the Flickr API an intuitive interface.}
+  gem.description   = %q{This gem is a nice wrapper for the Flickr API with an intuitive interface.}
   gem.summary       = %q{The reason why I did this gem is because the other ones either weren't well maintained, or they were too literal in the sense that the response from the API call wasn't processed almost at all. It doesn't seem too bad at first, but after a while you realize it's not pretty. So I wanted to make it pretty :)}
   gem.homepage      = "https://github.com/janko-m/flickrie"
 
@@ -15,5 +15,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Flickrie::VERSION
 
-  gem.add_dependency 'faraday-stack'
+  gem.add_dependency 'faraday_middleware'
+  gem.add_dependency 'simple_oauth'
 end

data/lib/flickrie/client.rb

@@ -1,31 +1,44 @@
-require 'faraday_stack'
+require 'faraday_middleware'
+require 'simple_oauth'
 
 module Flickrie
   class << self
-    attr_reader :api_key, :timeout, :open_timeout
-
-    def api_key=(api_key);      @client = nil; @api_key = api_key      end
-    def timeout=(api_key);      @client = nil; @timeout = api_key      end
-    def open_timeout=(api_key); @client = nil; @open_timeout = api_key end
+    attr_accessor :api_key, :shared_secret, :timeout, :open_timeout,
+      :token, :token_secret
 
     def client
       @client ||= begin
-        client = FaradayStack.build Client,
-          :url => 'http://api.flickr.com/services/rest/',
-          :params => {
-            :format => 'json',
-            :nojsoncallback => '1',
-            :api_key => self.api_key
-          },
-          :request => {
-            :open_timeout => self.open_timeout || 8,
-            :timeout => self.timeout || 8
-          }
-
-        client.builder.insert_before FaradayStack::ResponseJSON, StatusCheck
+        client = Client.new(params) do |conn|
+          conn.request :oauth,
+            :consumer_key => api_key,
+            :consumer_secret => shared_secret,
+            :token => token,
+            :token_secret => token_secret
+          conn.response :json, :content_type => /\bjson$/
+          conn.adapter Faraday.default_adapter
+        end
+
+        client.builder.insert_before FaradayMiddleware::ParseJson, StatusCheck
         client
       end
     end
+
+    private
+
+    def params
+      {
+        :url => 'http://api.flickr.com/services/rest/',
+        :params => {
+          :format => 'json',
+          :nojsoncallback => '1',
+          :api_key => api_key
+        },
+        :request => {
+          :open_timeout => open_timeout || 8,
+          :timeout => timeout || 8
+        }
+      }
+    end
   end
 
   class Error < StandardError
@@ -47,6 +60,13 @@ module Flickrie
       end
     end
 
+    def post(method, params = {})
+      super() do |req|
+        req.params[:method] = method
+        req.params.update(params)
+      end
+    end
+
     # people
     def find_user_by_email(email)
       get 'flickr.people.findByEmail', :find_email => email

data/lib/flickrie/oauth.rb

@@ -0,0 +1,79 @@
+module Flickrie
+  module OAuth
+    class RequestToken
+      attr_reader :token, :secret
+
+      def initialize(response_body)
+        @token = response_body[/(?<=oauth_token=)[^&]+/]
+        @secret = response_body[/(?<=oauth_token_secret=)[^&]+/]
+      end
+
+      def authorization_url(options = {})
+        url = "http://www.flickr.com/services/oauth/authorize?oauth_token=#{token}"
+        permissions = options[:permissions] || options[:perms]
+        url.concat("&perms=#{permissions}") if permissions
+        url
+      end
+    end
+
+    class Consumer
+      def initialize(api_key, shared_secret)
+        @api_key, @shared_secret = api_key, shared_secret
+      end
+
+      def get_request_token
+        connection = Faraday.new "http://www.flickr.com/services/oauth" do |conn|
+          conn.request :oauth,
+            :consumer_key => @api_key,
+            :consumer_secret => @shared_secret
+          conn.adapter :net_http
+        end
+
+        response = connection.get("request_token") do |req|
+          req.params[:oauth_callback] = 'oob'
+        end
+
+        RequestToken.new(response.body)
+      end
+
+      def get_access_token(oauth_verifier, request_token)
+        connection = Faraday.new "http://www.flickr.com/services/oauth" do |conn|
+          conn.request :oauth,
+            :consumer_key => @api_key,
+            :consumer_secret => @shared_secret,
+            :token => request_token.token,
+            :token_secret => request_token.secret
+          conn.adapter :net_http
+        end
+
+        response = connection.get "access_token" do |req|
+          req.params[:oauth_verifier] = oauth_verifier
+        end
+
+        [
+          response.body[/(?<=oauth_token=)[^&]+/],
+          response.body[/(?<=oauth_token_secret=)[^&]+/]
+        ]
+      end
+    end
+  end
+end
+
+module Flickrie
+  class << self
+    def get_authorization_url(options = {})
+      @request_token = consumer.get_request_token
+      @request_token.authorization_url(options)
+    end
+
+    def authorize!(code)
+      token, token_secret = consumer.get_access_token(code, @request_token)
+    end
+
+    private
+
+    def consumer
+      @consumer ||= OAuth::Consumer.new(api_key, shared_secret)
+    end
+  end
+end

data/lib/flickrie/version.rb

@@ -1,3 +1,3 @@
 module Flickrie
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/lib/flickrie.rb

@@ -1,4 +1,5 @@
 require 'flickrie/client'
+require 'flickrie/oauth'
 require 'flickrie/license'
 require 'flickrie/user'
 require 'flickrie/media'

data/test/oauth_test.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'flickrie'
+
+class OAuthTest < Test::Unit::TestCase
+  def setup
+    @photo_id = 6946979188
+    Flickrie.api_key = ENV['FLICKR_API_KEY']
+    Flickrie.shared_secret = ENV['FLICKR_SHARED_SECRET']
+    Flickrie.token = ENV['FLICKR_TOKEN']
+    Flickrie.token_secret = ENV['FLICKR_TOKEN_SECRET']
+  end
+
+  def test_permissions
+    assert_nothing_raised do
+      Flickrie.client.get "flickr.photos.getPerms", :photo_id => @photo_id
+      Flickrie.client.post "flickr.photos.setSafetyLevel", :photo_id => @photo_id, :safety_level => 1
+    end
+    assert_raises(Flickrie::Error) do
+      Flickrie.client.get "flickr.photos.delete", :photo_id => @photo_id
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flickrie
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-21 00:00:00.000000000 Z
+date: 2012-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday-stack
-  requirement: &70253217952440 !ruby/object:Gem::Requirement
+  name: faraday_middleware
+  requirement: &70166247860000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,8 +21,19 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70253217952440
-description: This gem is a nice wrapper for the Flickr API an intuitive interface.
+  version_requirements: *70166247860000
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: &70166247859580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70166247859580
+description: This gem is a nice wrapper for the Flickr API with an intuitive interface.
 email:
 - janko.marohnic@gmail.com
 executables: []
@@ -43,6 +54,7 @@ files:
 - lib/flickrie/media.rb
 - lib/flickrie/media/note.rb
 - lib/flickrie/media/visibility.rb
+- lib/flickrie/oauth.rb
 - lib/flickrie/photo.rb
 - lib/flickrie/set.rb
 - lib/flickrie/user.rb
@@ -52,6 +64,7 @@ files:
 - test/license_test.rb
 - test/location_test.rb
 - test/media_test.rb
+- test/oauth_test.rb
 - test/photo_test.rb
 - test/set_test.rb
 - test/user_test.rb
@@ -88,6 +101,7 @@ test_files:
 - test/license_test.rb
 - test/location_test.rb
 - test/media_test.rb
+- test/oauth_test.rb
 - test/photo_test.rb
 - test/set_test.rb
 - test/user_test.rb