flickraw_objects 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df7408e7add3e776767afd2eca89d358acca1dd0
+  data.tar.gz: 78a0f0d0149323c9b0f08d5911a0a71bfe91d84f
+SHA512:
+  metadata.gz: fb5dbad31880564a5b5b01aece7d02a2527efafc5a609466380f9e44e81d9221f554754792c579b70a3c8bfd9cfb4524d0391f12e32ea69e8644aa82fa8899a4
+  data.tar.gz: 3218518629387806727fd88793a76950dc2d71fda8edf2f84e612317eb92d894096d2c8b7197252d5e42063fd4cef5c47c32af874321f78b6d6ee9c65878caee

data/README.md

@@ -0,0 +1,55 @@
+# FlickrawObjects
+
+Use this gem as a simple way to map Flickraw results to a object-orientated "data model".
+Classes for People and Photos are included: These are there by way of an example. I anticipate 
+users of this Gem will map the data they need - it's easy to do.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flickraw_objects'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flickraw_objects
+
+## Usage
+
+Create an initializer where you set your Flickr credentials.
+
+```ruby
+FlickrawObjects.configure do |config|
+  config.api_key = "Your Api Key"
+  config.shared_secret = "Shared Secret"
+end
+```
+If you don't have them yet, you can apply for them [here](http://www.flickr.com/services/apps/create/apply).
+
+
+Example usage:
+
+```ruby
+person = FlickrawObjects::Person.find_by_username "chrisfield1968"
+puts "realname: #{person.realname}" # get_info api call happens automatically
+
+puts "photos_count #{person.photos_count}"                # returns as an Integer
+puts "person.first_date_taken #{person.first_date_taken}" # returns as a Date
+puts "professional?: #{person.professional?}"             # returns as a true/false
+
+person.get_photos.each_with_index do |item,i|
+  puts "item #{i}: #{item.title} - #{item.url} - #{item.public?}"
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/flickraw_objects/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/flickraw_objects.rb

@@ -0,0 +1,115 @@
+require "flickraw_objects/version"
+require "flickraw_objects/attributes"
+require "flickraw"
+require 'date'
+
+module FlickrawObjects
+
+  class Person 
+    include Attributes
+
+    def self.find_by_username(username)
+      response = flickr.people.findByUsername username: username
+      Person.new(response)
+    end
+
+    def get_photos(params = {})
+      result = Array.new
+      response = flickr.people.getPhotos user_id: id
+      response.each do |photo|
+        result << Photo.new(photo)
+      end
+      result
+    end
+    alias photos get_photos
+
+    def get_photosets(params = {})
+      result = Array.new
+      response = flickr.photosets.getList user_id: id
+      response.each do |photoset|
+        result << Photoset.new(photoset)
+      end
+      result
+    end
+    alias photosets get_photosets
+
+    def get_info
+      @get_info ||= flickr.people.getInfo user_id: id
+    end
+
+
+    attribute :id         
+    attribute :username
+
+    attribute_source :get_info
+    attribute :realname,                        path: [:realname]
+    attribute :photos_count,     type: Integer, path: [:photos, :count]
+    attribute :professional,     type: Boolean, path: [:ispro]
+    attribute :first_date_taken ,type: Time,    path: [:photos, :firstdatetaken]
+    attribute :first_date,       type: Time,    path: [:firstdate]
+
+  end
+
+  class Photoset
+    include Attributes
+
+    def get_photos(params = {})
+      result = Array.new
+      response = flickr.photosets.getPhotos(photoset_id: id)
+      response["photo"].each do |photo|
+        result << Photo.new(photo)
+      end
+      result
+    end
+
+    alias photos get_photos
+
+    def get_info
+      @get_info ||= flickr.photosets.getInfo photoset_id: id
+    end
+  
+    attribute :id
+    attribute :title
+    attribute :description  
+
+    attribute_source :get_info
+    attribute :primary  
+
+
+  end
+
+  class Photo
+    include Attributes
+    attribute :id
+    attribute :owner
+    attribute :secret
+    attribute :server
+    attribute :farm
+    attribute :title
+    attribute :public, type: Boolean, path: [:ispublic]
+    attribute :friend, type: Boolean, path: [:isfriend]
+    attribute :family, type: Boolean, path: [:isfamily]
+
+    def url_medium
+      FlickRaw.url(init)
+    end
+
+    def self.url(letter, meaning) 
+      define_method("url_#{meaning}") do
+        FlickRaw.send("url_#{letter}", init)
+      end
+    end
+
+    url :s , :square
+    url :q , :large_square
+    url :t , :thumbnail
+    url :m , :small
+    url :n , :small_320
+    url :z , :medium_640
+    url :c , :medium_800
+    url :b , :large
+    url :o , :original
+
+  end
+
+end

data/lib/flickraw_objects.rb~

@@ -0,0 +1,119 @@
+require "flickraw_objects/version"
+require 'date'
+require "flickraw_objects/configuration"
+require "flickraw_objects/attributes"
+
+module FlickrawObjects
+
+  class Person 
+    include Attributes
+
+    def self.find_by_username(username)
+      response = flickr.people.findByUsername username: username
+      Person.new(response)
+    end
+
+    def get_info
+      @get_info ||= flickr.people.getInfo user_id: id
+    end
+
+    def get_photos
+      result = Array.new
+      response = flickr.people.getPhotos user_id: id
+      response.each do |photo|
+        result << Photo.new(photo)
+      end
+      result
+    end
+    alias photos get_photos
+
+    def get_photosets
+      PhotoSet.list(id)
+    end
+
+
+    attribute :id         
+    attribute :username
+
+    attribute_source :get_info
+    attribute :realname,                        path: [:realname]
+    attribute :photos_count,     type: Integer, path: [:photos, :count]
+    attribute :professional,     type: Boolean, path: [:ispro]
+    attribute :first_date_taken ,type: Time,    path: [:photos, :firstdatetaken]
+    attribute :first_date,       type: Time,    path: [:firstdate]
+
+  end
+
+  class PhotoSet
+    include Attributes
+
+    def self.list(user_id)
+      result = Array.new
+      response = flickr.photosets.getList user_id: user_id
+      response.each do |item|
+        result << PhotoSet.new(item)
+      end
+      result
+    end
+
+    def self.find(photoset_id)
+      info = flickr.photosets.getInfo photoset_id: photoset_id
+      result = PhotoSet.new(info)
+      result.get_info = info
+      result
+    end
+
+    attr_writer :get_info
+    def get_info
+      @get_info ||= flickr.photosets.getInfo photoset_id: id
+    end
+
+    def get_photos
+      result = Array.new
+      response = flickr.photosets.getPhotos photoset_id: id
+      puts response.inspect
+      response.photo.each do |photo|
+        result << Photo.new(photo)
+      end
+      result
+    end
+    alias photos get_photos
+
+    attribute :id
+    attribute :primary 
+    attribute :secret
+    attribute :server
+    attribute :photos_count, type: Integer, path: [:count_photos]
+    attribute :views_count, type: Integer, path: [:count_views]
+    attribute :comments_count, type: Integer, path: [:count_comments]
+    attribute :videos_count, type: Integer, path: [:count_videos]
+    attribute :can_comment, type: Boolean
+    attribute :created, type: Time, path: [:date_create]
+    attribute :updated, type: Time, path: [:date_update]
+    attribute :title
+    attribute :description
+
+    attribute_source :get_info
+    attribute :owner
+
+  end
+
+  class Photo
+    include Attributes
+    attribute :id
+    attribute :owner
+    attribute :secret
+    attribute :server
+    attribute :farm
+    attribute :title
+    attribute :public, type: Boolean, path: [:ispublic]
+    attribute :friend, type: Boolean, path: [:isfriend]
+    attribute :family, type: Boolean, path: [:isfamily]
+
+    def url
+      "http://farm#{farm}.staticflickr.com/#{server}/#{id}_#{secret}.jpg"
+    end
+  end
+
+
+end

data/lib/flickraw_objects/attributes.rb

@@ -0,0 +1,67 @@
+module FlickrawObjects
+
+  module Attributes
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module Boolean
+    end
+
+    COERCIONS = {
+      String  => lambda { |value| String(value) },
+      Boolean => lambda { |value| Integer(value) == 1 },
+      Integer => lambda { |value| Integer(value) },
+      Float => lambda { |value| Float(value) },
+      Time => lambda { |value|
+        begin
+          Time.at(Integer(value))
+        rescue
+          DateTime.parse(value).to_time 
+        end
+      }
+    }
+
+    module ClassMethods
+    
+      def attribute_source(value) 
+        @attribute_source = value
+      end
+    
+      def attribute(name, type: nil, path: [])
+        source = "@#{(@attribute_source || :init)}"
+        define_method(name) do
+          response = instance_variable_get(source)
+          if path.empty?
+            value = response.send name
+          else
+            value = path.inject(response) {|result, element| result.send element} 
+          end
+          COERCIONS.fetch(type || String).call(value)
+        end
+        alias_method "#{name}?", name if type == Boolean
+        if @attribute_source
+          alias_method_chain(@attribute_source, name)
+        end
+
+        name
+      end
+
+      def alias_method_chain(first_method, second_method)
+        define_method("#{second_method}_with_#{first_method}") do
+          method(first_method).call 
+          method("#{second_method}_without_#{first_method}").call
+        end
+        alias_method "#{second_method}_without_#{first_method}", second_method 
+        alias_method second_method, "#{second_method}_with_#{first_method}"
+      end
+    
+    end
+
+    attr_reader :init
+
+    def initialize(response) 
+        @init = response 
+    end
+  end
+end

data/lib/flickraw_objects/attributes.rb~

@@ -0,0 +1,70 @@
+module FlickrawObjects
+
+  module Attributes
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module Boolean
+    end
+
+    module ClassMethods
+    
+      def attribute_source(value) 
+        @attribute_source = value
+      end
+
+      COERCIONS = {
+           Boolean => lambda { |value| Integer(value) == 1 },
+           Integer => lambda { |value| Integer(value) },
+           Float   => lambda { |value| Float(value) },
+           Time    => 
+            lambda { |value|
+              begin
+                Time.at(Integer(value))
+              rescue
+                DateTime.parse(value).to_time 
+              end
+            },
+            String => lambda { |value| String(value) }
+          }
+
+      def attribute(name, type: nil, path: [])
+        source = "@#{(@attribute_source || :init)}"
+        coercion = COERCIONS.fetch(type || String)
+
+        define_method(name) do
+          response = instance_variable_get(source)
+          if path.empty?
+            value = response.send name
+          else
+            value = path.inject(response) {|result, element| result.send element} 
+          end
+          coercion.call(value)
+        end
+        if @attribute_source
+          alias_method_chain(@attribute_source, name)
+        end
+        alias_method "#{name}?", name if type == Boolean
+
+        name
+      end
+
+      def alias_method_chain(first_method, second_method)
+        define_method("#{second_method}_with_#{first_method}") do
+          method(first_method).call 
+          method("#{second_method}_without_#{first_method}").call
+        end
+        alias_method "#{second_method}_without_#{first_method}", second_method 
+        alias_method second_method, "#{second_method}_with_#{first_method}"
+      end
+    
+    end
+
+    attr_reader :init
+
+    def initialize(response) 
+        @init = response 
+    end
+  end
+end

data/lib/flickraw_objects/version.rb

@@ -0,0 +1,3 @@
+module FlickrawObjects
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: flickraw_objects
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Field
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flickraw
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: "Use this gem as a simple way to use Flickraw but with an object-orientated
+  \"data model\".\n    Classes for Person, Photoset and Photos are included. I anticipate
+  \n    users of this Gem will map other data they need. It's easy to do."
+email:
+- chris@christopherfield.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/flickraw_objects.rb
+- lib/flickraw_objects.rb~
+- lib/flickraw_objects/attributes.rb
+- lib/flickraw_objects/attributes.rb~
+- lib/flickraw_objects/version.rb
+homepage: https://github.com/chrisfield/flickraw_objects
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A slim, customisable object-oriented Flickr api that uses flickraw to do
+  all the communication.
+test_files: []
+has_rdoc: