flickr_search 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ed3e48a1aa0e22b16d83caa13515c0ee3319d2a
+  data.tar.gz: fc494ba54f75d953f36db75d3997fb26ae2c72ff
+SHA512:
+  metadata.gz: 48ff419055295d90108569ca257bf408cd4b8ffb55de759a2662c88c022eb7286e9bc8f0c010e63a95d916e02abc44265b309ad56e051bf2a0f79b223dcab370
+  data.tar.gz: 47f1e280261e708386fdec9efb1b4fdc8db0308ac2cbd1bec8d6d8b40deca2616b2323bef5eb88bc869060d805a8ef0ba27efe2197c525691c584485abda4280

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/fixtures/vcr_cassettes/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flickr_search.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Raman Sinha
+
+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,67 @@
+# FlickrSearch
+
+Allows you to use add public images from Flickr into your application using your own Flickr Developer API credentials.
+
+Please note you are responsible for making sure your usage of the Flickr API adheres to their guidelines which you read when you signed-up for an API key, right? :-)
+
+Extracted from a little example Ruby 2.1.0p0 / Rails 4.0.2 app that accompanies my talk about Mining for Gems in your Rails App.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flickr_search', git: 'git://github.com/velobuff/flickr_search.git'
+
+And then execute:
+
+    $ bundle
+
+Then create an environment variable (pick your favorite method or read http://railsapps.github.io/rails-environment-variables.html if you don't have one yet) to make your FLICKR_API_KEY available to the gem.
+
+The quick-and-dirty way to add an environment variable for testing is:
+```
+ $export FLICKR_API_KEY='YOUR_OWN_DEVELOPER_KEY'
+```
+
+Alternatively, you can send in your api key as an optional parameter when you're new-ing up the FlickrSearch object but this is highly discouraged because you'll inadvertently end up sharing your api key when you push your code to GitHub. Plus saving your config within the app is not http://12factor.net - savvy anyway. And you do want to be savvy, don't you?
+
+
+## Rails Usage
+
+In your controller, instantiate an instance & pass it a search term.
+
+```
+  @flickr = FlickrSearch::FlickrSearch.new
+  @flickr.search("Boulder, Colorado")
+
+  #or just
+
+  @flickr = FlickrSearch::FlickrSearch.new.search("Boulder, Colorado")
+
+```
+
+Then use the your instance to populate an img src in your View or something
+
+```
+<% if @flickr %>
+  <%= @flickr.num_results %> photos found for <%= @flickr.search_query %>. Here's one:
+  <br/>
+  <%= image_tag @flickr.random_photo_url %>
+  <br/>
+  <%= @flickr.random_photo_description %>
+<% end %>
+```
+
+## TODO
+
+* More intelligent searching (tags vs. description, AND vs. OR, etc), some image metadata attributes or just METAprogram the parameters @ http://www.flickr.com/services/api/flickr.photos.search.html
+* Return the url of a local 404 image if there are any errors or timeouts calling Flickr api
+* Perpetual Refactoring
+
+## Contributing
+
+1. Fork it ( http://github.com/velobuff/flickr_search/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/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+# make irb easy for use with gem development
+# http://simonecarletti.com/blog/2009/09/rake-console/
+namespace :velobuff do
+  task :console  do
+    sh "irb -rubygems -I lib -r flickr_search.rb"
+  end
+end

data/flickr_search.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flickr_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flickr_search"
+  spec.version       = FlickrSearch::VERSION
+  spec.authors       = ["Raman Sinha"]
+  spec.email         = ["velobuff@gmail.com"]
+  spec.summary       = %q{Simple photo search for Flickr}
+  spec.description   = %q{Search photos on Flickr using your Flickr developer API credentials.}
+  spec.homepage      = "http://github.com/velobuff/flickr_search/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "faraday", "~> 0.9.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec" , "~> 2.14.1"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock", "~> 1.15.0" #vcr complains
+  spec.add_development_dependency "guard-rspec"
+
+end

data/lib/flickr_search.rb

@@ -0,0 +1,2 @@
+require "flickr_search/version"
+require "flickr_search/flickr_search"

data/lib/flickr_search/flickr_search.rb

@@ -0,0 +1,94 @@
+require 'Faraday'
+
+module FlickrSearch
+  class FlickrSearch
+
+    def initialize(api_key = nil)
+      @api_key = api_key if api_key
+    end
+
+    def search(query)
+      @search_query = query
+      #https://api.flickr.com/services/rest/?method=flickr.photos.search&api_key=8488f3aeb049689b2f6aec5ff0859de5&text=denver&format=json&nojsoncallback=1
+      @response = conn.get do |req|
+        req.url flickr_endpoint, api_key: api_key, method: api_method, text: search_query, format: format, nojsoncallback: 1
+      end
+
+      self #otherwise we'd be returning @response which is a Faraday::Response and we wouldn't be able to chain as expected
+    end
+
+    def search_query
+      @search_query
+    end
+
+    def api_key
+      @api_key ||= ENV['FLICKR_API_KEY']
+    end
+
+    def num_results
+      json_response["photos"]["total"].to_i
+    end
+
+    def random_photo_urls(how_many)
+        photos = Array.new
+        how_many.times.each { photos << photo_url(random_photo) }
+        photos
+    end
+
+    def random_photo_url
+      photo_url random_photo
+    end
+
+    def random_photo_description
+      random_photo["title"]
+    end
+
+    private
+
+      def random_photo
+        json_response["photos"]["photo"].sample
+      end
+
+      def photo_url(photo_json, photo_size = nil)
+
+        farm = photo_json["farm"]
+        server = photo_json["server"]
+        id = photo_json["id"]
+        secret = photo_json["secret"]
+        size = photo_size || "_b"
+
+        "http://farm#{farm}.staticflickr.com/#{server}/#{id}_#{secret}#{size}.jpg"
+
+      end
+
+      def response
+         @response
+      end
+
+      def json_response
+       @json_response ||= JSON.parse(response.body)
+      end
+
+      def api_method
+        @api_method ||= %q{flickr.photos.search}
+      end
+
+      def format
+        @format ||= "json"
+      end
+
+      def conn
+        @conn ||= Faraday.new(:url => flickr_endpoint) do |f|
+          f.request :url_encoded
+          f.response :logger
+          f.adapter Faraday.default_adapter
+        end
+      end
+
+      def flickr_endpoint
+        @flickr_endpoint ||= %q{https://api.flickr.com/services/rest/}
+      end
+
+  end
+
+end

data/lib/flickr_search/version.rb

@@ -0,0 +1,3 @@
+module FlickrSearch
+  VERSION = "0.0.4"
+end

data/spec/flickr_search/flickr_search_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe FlickrSearch::FlickrSearch do
+
+  let(:api_key) { ENV['FLICKR_API_KEY'] }
+
+  context "Object instantiation" do
+
+    let(:flickr_search) {FlickrSearch::FlickrSearch.new(api_key)}
+
+    it "should load properly}" do
+      flickr_search.should be_kind_of(FlickrSearch::FlickrSearch)
+    end
+
+    it "should have an api key" do
+      flickr_search.api_key.should eql(api_key)
+    end
+
+    it "api key shouldn't be nil unless the dev forgot to set the env variable" do
+      flickr_search.api_key.should_not eql(nil)
+    end
+
+  end
+
+  context "perform search" do
+
+    let(:search_term) { "boulder" }
+
+      let(:flickr_search) {
+        VCR.use_cassette "boulder" do
+          FlickrSearch::FlickrSearch.new(api_key).search(search_term)
+        end
+      }
+
+    it "should remember the search term" do
+      flickr_search.search_query.should eql(search_term)
+    end
+
+    it "should have > 1 search results" do
+      flickr_search.num_results.should_not eql(0)
+    end
+
+    it "should have alot of search results" do
+      flickr_search.num_results.should be > 1000
+    end
+
+    it "should return a photo's URL" do
+      flickr_search.random_photo_url.should_not eql(nil)
+    end
+
+    it "should return a photo's description" do
+      flickr_search.random_photo_description.should_not eql(nil)
+    end
+
+    it "should return 5 photos" do
+      urls=flickr_search.random_photo_urls(5)
+      urls.count.should be 5
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'flickr_search'
+require 'faraday'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: flickr_search
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Raman Sinha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: guard-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'
+description: Search photos on Flickr using your Flickr developer API credentials.
+email:
+- velobuff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flickr_search.gemspec
+- lib/flickr_search.rb
+- lib/flickr_search/flickr_search.rb
+- lib/flickr_search/version.rb
+- spec/flickr_search/flickr_search_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/velobuff/flickr_search/
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Simple photo search for Flickr
+test_files:
+- spec/flickr_search/flickr_search_spec.rb
+- spec/spec_helper.rb