flickrie 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+TODO.md
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem "faraday-stack", :require => false
+gem 'activesupport'
+gem "rake"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Janko Marohnić
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,151 @@
+# Flickrie
+
+## About
+
+This gem is a nice wrapper for the Flickr API 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
+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 :)
+
+## Examples of usage
+
+You first need to set the API key.
+
+```ruby
+require 'flickrie'
+Flickr.api_key = "some_api_key"
+```
+
+Then you can search for photos.
+
+```ruby
+photos = Flickr.photos_from_set(819234) # => [#<Photo: id="8232348", ...>, #<Photo: id="8194318", ...>, ...]
+
+photo = photos.first
+photo.id          # => "8232348"
+photo.url         # => "http://www.flickr.com/photos/67313352@N04/8232348"
+photo.title       # => "Samantha and me"
+photo.owner       # => #<User: nsid="67313352@N04", ...>
+photo.owner.nsid  # => "67313352@N04"
+```
+
+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')
+
+photo = photos.first
+photo.tags           # => "cave cold forrest"
+photo.owner.username # => "jsmith"
+photo.updated_at     # => 2012-04-20 23:29:17 +0200
+photo.views_count    # => 24
+```
+
+On the list of available parameters you can read in the [Flickr API documentation](http://www.flickr.com/services/api/), under the corresponding API method name (in the above case it's `flickr.photosets.getPhotos`).
+
+You can also get additional info on a single photo:
+
+```ruby
+photo = Flickr.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"
+```
+
+You can also get this info on an existing photo:
+
+```ruby
+photo.description # => nil
+photo.get_info
+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.medium!(800)
+photo.size       # => "Medium 800"
+photo.source_url # => "http://farm8.staticflickr.com/7049/6946979188_25bb44852b_c.jpg"
+photo.width      # => 600
+photo.height     # => 800
+
+photo.small!(320)
+photo.size       # => "Small 320"
+photo.source_url # => "http://farm8.staticflickr.com/7049/6946979188_25bb44852b_n.jpg"
+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:
+
+```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')
+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 :)
+
+## 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:
+
+```ruby
+response = Flickr.client.get("flickr.photos.getContext", :photo_id => 2842732)
+reponse.body # =>
+# {
+#   "count" => {"_content" => 99},
+#   "prevphoto" => {
+#     "id" => "6946978706",
+#     "secret" => "b38270bbd6",
+#     ...
+#   }
+#   "nextphoto" => {
+#     "id" => "6946979704",
+#     "secret" => "74513ff732",
+#     ...
+#   }
+# }
+```
+
+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.
+
+## Currently covered API methods
+
+### people
+- `flickr.people.findByEmail`
+- `flickr.people.findByUsername`
+- `flickr.people.getInfo`
+- `flickr.people.getPublicPhotos`
+
+### photos
+- `flickr.photos.getInfo`
+- `flickr.photos.getSizes`
+- `flickr.photos.search`
+
+### photos.licenses
+- `flickr.photos.licenses.getInfo`
+
+### photosets
+- `flickr.photosets.getInfo`
+- `flickr.photosets.getList`
+- `flickr.photosets.getPhotos`
+
+## License
+
+[MIT](http://github.com/janko-m/flickrie/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+CURRENT_DIR = File.expand_path(File.dirname(__FILE__))
+
+task :test do
+  Dir["#{CURRENT_DIR}/test/**/*_test.rb"].each do |test|
+    system "ruby -Ilib -Itest #{test}"
+  end
+end
+
+namespace :test do
+  test_rbs = Dir["#{CURRENT_DIR}/test/*_test.rb"]
+  test_rbs.map { |t| File.basename(t).chomp('_test.rb') }.each do |test_name|
+    task(test_name.to_sym) do
+      system "ruby -Ilib -Itest test/#{test_name}_test.rb"
+    end
+  end
+end

data/finished_api_methods.md

@@ -0,0 +1,84 @@
+# activity
+
+# auth
+
+# auth.oauth
+
+# blogs
+
+# collections
+
+# commons
+
+# contacts
+
+# favorites
+
+# galleries
+
+# groups
+
+# groups.members
+
+# groups.pools
+
+# interestingness
+
+# machinetags
+
+# panda
+
+# people
+
+- flickr.people.findByEmail
+- flickr.people.findByUsername
+- flickr.people.getInfo
+- flickr.people.getPublicPhotos
+
+# photos
+
+- flickr.photos.getInfo
+- flickr.photos.getSizes
+- flickr.photos.search
+
+# photos.comments
+
+# photos.geo
+
+# photos.licenses
+
+- flickr.photos.licenses.getInfo
+
+# photos.notes
+
+# photos.people
+
+# photos.suggestions
+
+# photos.transform
+
+# photos.upload
+
+# photosets
+
+- flickr.photosets.getInfo
+- flickr.photosets.getList
+- flickr.photosets.getPhotos
+
+# photosets.comments
+
+# places
+
+# prefs
+
+# push
+
+# reflection
+
+# stats
+
+# tags
+
+# test
+
+# urls

data/flickrie.gemspec

@@ -0,0 +1,20 @@
+# encoding: utf-8
+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.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"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "flickrie"
+  gem.require_paths = ["lib"]
+  gem.version       = Flickrie::VERSION
+
+  gem.add_dependency 'faraday-stack'
+  gem.add_dependency 'activesupport'
+end

data/lib/flickrie/client.rb

@@ -0,0 +1,103 @@
+require 'faraday_stack'
+
+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
+
+    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
+      end
+    end
+  end
+
+  class Error < StandardError
+  end
+
+  class StatusCheck < Faraday::Response::Middleware
+    def on_complete(env)
+      if env[:body]['stat'] != 'ok'
+        raise Error, env[:body]['message']
+      end
+    end
+  end
+
+  class Client < Faraday::Connection
+    def get(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
+    end
+
+    def find_user_by_username(username)
+      get 'flickr.people.findByUsername', :username => username
+    end
+
+    def get_user_info(user_nsid)
+      get 'flickr.people.getInfo', :user_id => user_nsid
+    end
+
+    def public_media_from_user(user_nsid, params = {})
+      params = {:user_id => user_nsid}.merge(params)
+      params[:extras] = [params[:extras], 'media'].compact.join(',')
+      get 'flickr.people.getPublicPhotos', params
+    end
+
+    # photos
+    def get_media_info(media_id)
+      get 'flickr.photos.getInfo', :photo_id => media_id
+    end
+
+    def get_media_sizes(media_id)
+      get 'flickr.photos.getSizes', :photo_id => media_id
+    end
+
+    def search_media(params = {})
+      params[:extras] = [params[:extras], 'media'].compact.join(',')
+      get 'flickr.photos.search', params
+    end
+
+    # licenses
+    def get_licenses
+      get 'flickr.photos.licenses.getInfo'
+    end
+
+    # photosets
+    def get_set_info(set_id)
+      get 'flickr.photosets.getInfo', :photoset_id => set_id
+    end
+
+    def sets_from_user(user_nsid)
+      get 'flickr.photosets.getList', :user_id => user_nsid
+    end
+
+    def media_from_set(set_id, params = {})
+      params = {:photoset_id => set_id}.merge(params)
+      params[:extras] = [params[:extras], 'media'].compact.join(',')
+      get 'flickr.photosets.getPhotos', params
+    end
+  end
+end

data/lib/flickrie/license.rb

@@ -0,0 +1,38 @@
+module Flickrie
+  class License
+    attr_reader :id, :name, :url
+
+    private
+
+    def initialize(argument)
+      if argument.is_a?(Hash)
+        @id = argument['id']
+        @name = argument['name']
+        @url = argument['url']
+      elsif argument.is_a?(String)
+        hash = self.class.response_array.find do |hash|
+          hash['id'] == argument
+        end
+        initialize(hash)
+      end
+    end
+
+    def self.response_array
+      [
+        {"id"=>"0", "name"=>"All Rights Reserved", "url"=>""},
+        {"id"=>"1", "name"=>"Attribution-NonCommercial-ShareAlike License", "url"=>"http://creativecommons.org/licenses/by-nc-sa/2.0/"},
+        {"id"=>"2", "name"=>"Attribution-NonCommercial License", "url"=>"http://creativecommons.org/licenses/by-nc/2.0/"},
+        {"id"=>"3", "name"=>"Attribution-NonCommercial-NoDerivs License", "url"=>"http://creativecommons.org/licenses/by-nc-nd/2.0/"},
+        {"id"=>"4", "name"=>"Attribution License", "url"=>"http://creativecommons.org/licenses/by/2.0/"},
+        {"id"=>"5", "name"=>"Attribution-ShareAlike License", "url"=>"http://creativecommons.org/licenses/by-sa/2.0/"},
+        {"id"=>"6", "name"=>"Attribution-NoDerivs License", "url"=>"http://creativecommons.org/licenses/by-nd/2.0/"},
+        {"id"=>"7", "name"=>"No known copyright restrictions", "url"=>"http://www.flickr.com/commons/usage/"},
+        {"id"=>"8", "name"=>"United States Government Work", "url"=>"http://www.usa.gov/copyright.shtml"}
+      ]
+    end
+
+    def self.from_hash(licenses_hash)
+      licenses_hash.map { |info| new(info) }
+    end
+  end
+end

data/lib/flickrie/location.rb

@@ -0,0 +1,62 @@
+module Flickrie
+  class Location
+    %w[latitude longitude accuracy context place_id woeid].each do |attr_name|
+      define_method(attr_name) do
+        @info[attr_name]
+      end
+    end
+
+    %w[neighbourhood locality county region country].each do |place_name|
+      define_method(place_name) do
+        if @info[place_name]
+          Struct.new(:name, :place_id, :woeid).new \
+            @info[place_name]['_content'],
+            @info[place_name]['place_id'],
+            @info[place_name]['woeid']
+        end
+      end
+    end
+
+    private
+
+    def initialize(info = {})
+      @info = info
+    end
+  end
+end
+
+__END__
+
+{
+  "latitude" => 37.792608,
+  "longitude" => -122.402672,
+  "accuracy" => "14",
+  "context" => "0",
+  "neighbourhood" => {
+    "_content" => "Financial District",
+    "place_id" => "GddgqTpTUb8LgT93hw",
+    "woeid" => "23512022"
+  },
+  "locality" => {
+    "_content" => "San Francisco",
+    "place_id" => "7.MJR8tTVrIO1EgB",
+    "woeid" => "2487956"
+  },
+  "county" => {
+    "_content" => "San Francisco",
+    "place_id" => ".7sOmlRQUL9nK.kMzA",
+    "woeid" => "12587707"
+  },
+  "region" => {
+    "_content" => "California",
+    "place_id" => "NsbUWfBTUb4mbyVu",
+    "woeid" => "2347563"
+  },
+  "country" => {
+    "_content" => "United States",
+    "place_id" => "nz.gsghTUb4c2WAecA",
+    "woeid" => "23424977"
+  },
+  "place_id" =>"GddgqTpTUb8LgT93hw",
+  "woeid" =>"23512022"
+}

data/lib/flickrie/media/note.rb

@@ -0,0 +1,23 @@
+module Flickrie
+  module Media
+    class Note
+      attr_reader :id, :author, :coordinates, :content,
+        :width, :height
+
+      def to_s
+        @content
+      end
+
+      def initialize(hash)
+        @id = hash['id']
+        @author = User.new \
+          'nsid' => hash['author'],
+          'username' => hash['authorname']
+        @content = hash['_content']
+        @coordinates = [hash['x'].to_i, hash['y'].to_i]
+        @width = hash['w'].to_i
+        @height = hash['h'].to_i
+      end
+    end
+  end
+end

data/lib/flickrie/media/visibility.rb

@@ -0,0 +1,14 @@
+module Flickrie
+  module Media
+    class Visibility
+      def public?;   @visibility[0].to_i == 1 if @visibility[0]   end
+      def friends?;  @visibility[1].to_i == 1 if @visibility[1]   end
+      def family?;   @visibility[2].to_i == 1 if @visibility[2]   end
+      def contacts?; @visibility[3].to_i == 1 if @visibility[3]   end
+
+      def initialize(*visibility)
+        @visibility = visibility.flatten
+      end
+    end
+  end
+end