flickpaper 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b82140cd93717729460dbd662f37d9c26014e19
-  data.tar.gz: 2ad72a3424f3c4957cbddc4f6400d1706ff25210
+  metadata.gz: 8416847871609b13d927e4e9cb892a7b62548697
+  data.tar.gz: a3aa388f991e63ffb78ca98f881d8ac6d957ee44
 SHA512:
-  metadata.gz: 2347aa154ab92ceea8eac4b4ef1d206ed8a087d87a5f44d549a9259b2055a1fe3681b9b555c9056ab68d1f7bb45fece6f6a2409bd25e87090e5f725618f32f07
-  data.tar.gz: e5d00b9323457841f0c9a0926b648089ece01c2796cc198cf395664d063653e38dee48b6a4daaa8f2bf9138266067735c9fa6731172862b91b8bb4b85e89e417
+  metadata.gz: 71075de7292559348356e1cb344f6b7bef71884c308e94ace4cb411f7ae3587963c6022645ac96387e05b6542ccc1c67eb4698f9a108736af14b5423e0cfec39
+  data.tar.gz: 78ed6977afe25984ceeb06b55636533142deb2df4b7bf2dde1b6ac7b34c4d4d2e055fc7b1459ab431dbc27954378dbd7b4cc721087a42c34b3e11005217446cb

data/README.md

@@ -1,6 +1,9 @@
 # Flickpaper
 
-A [Flickr App](https://www.flickr.com/services/apps/72157658406991003) that sets your GNOME wallpaper to a recent interesting photo
+A [Ruby Gem](https://rubygems.org/gems/flickpaper) and [Flickr App](https://www.flickr.com/services/apps/72157658406991003)
+that sets your GNOME or OSX wallpaper to a recent interesting photo.
+
+Does not (and will likely never) work under MS Windows.
 
 ## Installation
 
@@ -26,14 +29,35 @@ $ bundle
 
 ```shell
 Usage: $ flickpaper [options]
-    -d, --dump [PATH]                Dump file for used photo ids. Default: $HOME/.flickpaper.dump
-    -i, --image [PATH]               Where to store the downloaded image. Default: $HOME/.flickpaper.jpg
-    -v, --verbose                    Verbose
-        --version                    Show version
+    -d, --dump PATH                  Dump file for used photo ids. Default: $HOME/.flickpaper.dump
+    -i, --image PATH                 Where to store the downloaded image. Default: $HOME/.flickpaper.jpg
+    -l, --log PATH                   Path to log file. Default: STDOUT
+    -p, --per-page PER_PAGE          Number of interesting photos per page in flickr api call. Default: 100
+        --date DATE                  A specific date, formatted as YYYY-MM-DD, to return interesting photos for. Default: null (most recent)
+        --page PAGE                  The page of results to return. Default: 1
+    -s, --size SIZE                  Minimum acceptable image size. Default: Large 2048
+    -v, --verbose                    Be verbose.
+        --sizes                      Print sizes and exit.
+        --version                    Show version and exit.
 ```
 
 Use with cron to periodically get a new interesting desktop wallpaper.
 
+Most of the time you are using a ruby switcher (rvm, rbenv, chruby, etc), which means
+you will want a way to call the correct gem executable via cron. A script similar to this will
+work for chruby. You would need to adapt it for your ruby switcher and ruby version.
+
+```shell
+#!/bin/bash
+
+source /usr/local/share/chruby/chruby.sh
+chruby ruby-2.2.0
+FLICKPAPER=`which flickpaper`
+if [ ! -z "$FLICKPAPER" ]; then
+  $FLICKPAPER
+fi
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/atongen/flickpaper/fork )

data/flickpaper.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Flickpaper::VERSION
   spec.authors       = ["Andrew Tongen"]
   spec.email         = ["atongen@gmail.com"]
-  spec.summary       = %q{Sets your GNOME wallpaper to a recent interesting photo from flickr}
-  spec.description   = IO.read(File.join(File.dirname(__FILE__), 'README.md'))
+  spec.summary       = %q{Sets your GNOME or OSX wallpaper to a recent interesting photo from flickr}
+  spec.description   = %q{Sets your GNOME or OSX wallpaper to a recent interesting photo from flickr}
   spec.homepage      = "http://github.com/atongen/flickpaper"
   spec.license       = "MIT"
 

data/lib/flickpaper.rb

@@ -8,7 +8,23 @@ require 'logger'
 
 module Flickpaper
   API_KEY = '23005d9cf8cc185c1c2d17152d03d98b'
-  SHARED_SECRET = 'a6e67612f607b407'
+  # Shared secret not required?
+  SHARED_SECRET = ''
+
+  SIZES = %w{
+    Square
+    Large\ Square
+    Thumbnail
+    Small
+    Small\ 320
+    Medium
+    Medium\ 640
+    Medium\ 800
+    Large
+    Large\ 1600
+    Large\ 2048
+    Original
+  }
 
   def self.init
     FlickRaw.api_key = API_KEY
@@ -18,24 +34,44 @@ module Flickpaper
   def self.parse_opts(opts)
     options = {
       dump: File.join(ENV['HOME'], '.flickpaper.dump'),
-      image: File.join(ENV['HOME'], '.flickpaper.jpg'),
-      log: nil
+      image: get_default_image_path,
+      log: nil,
+      per_page: 100,
+      date: nil,
+      page: 1,
+      size: 'Large 2048'
     }
     opt_parser = OptionParser.new do |opts|
       opts.banner = "Usage: $ #{File.basename($0)} [options]"
-      opts.on('-d', '--dump [PATH]', "Dump file for used photo ids. Default: #{options[:dump]}") do |dump|
+      opts.on('-d', '--dump PATH', "Dump file for used photo ids. Default: #{options[:dump]}") do |dump|
         options[:dump] = dump
       end
-      opts.on('-i', '--image [PATH]', "Where to store the downloaded image. Default: #{options[:image]}") do |image|
+      opts.on('-i', '--image PATH', "Where to store the downloaded image. Default: #{options[:image]}") do |image|
         options[:image] = image
       end
-      opts.on('-l', '--log [PATH]', "Path to log file. Default: STDOUT") do |log|
+      opts.on('-l', '--log PATH', "Path to log file. Default: STDOUT") do |log|
         options[:log] = log
       end
-      opts.on('-v', '--verbose', 'Verbose') do |verbose|
+      opts.on('-p', '--per-page PER_PAGE', "Number of interesting photos per page in flickr api call. Default: #{options[:per_page]}") do |per_page|
+        options[:per_page] = per_page
+      end
+      opts.on('--date DATE', "A specific date, formatted as YYYY-MM-DD, to return interesting photos for. Default: null (most recent)") do |date|
+        options[:date] = date
+      end
+      opts.on('--page PAGE', "The page of results to return. Default: #{options[:page]}") do |page|
+        options[:page] = page
+      end
+      opts.on('-s', '--size SIZE', "Minimum acceptable image size. Default: #{options[:size]}") do |size|
+        options[:size]= size
+      end
+      opts.on('-v', '--verbose', 'Be verbose.') do |verbose|
         options[:verbose] = verbose
       end
-      opts.on_tail("--version", "Show version") do
+      opts.on('--sizes', "Print sizes and exit.") do |sizes|
+        puts SIZES.join(', ')
+        exit 0
+      end
+      opts.on_tail("--version", "Show version and exit.") do
         puts Flickpaper::VERSION
         exit 0
       end
@@ -44,30 +80,6 @@ module Flickpaper
     [opts, options]
   end
 
-  # date (Optional)
-  #   A specific date, formatted as YYYY-MM-DD, to return interesting photos for.
-  # extras (Optional)
-  #   A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_q, url_m, url_n, url_z, url_c, url_l, url_o
-  # per_page (Optional)
-  #   Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
-  # page (Optional)
-  #   The page of results to return. If this argument is omitted, it defaults to 1.
-  def self.interesting(options = {})
-    flickr.interestingness.getList(options)
-  end
-
-  def self.infos(list)
-    list.map do |photo|
-      flickr.photos.getInfo(photo_id: photo['id'])
-    end
-  end
-
-  def self.sizes(list)
-    list.map do |photo|
-      flickr.photos.getSizes(photo_id: photo['id'])
-    end
-  end
-
   def self.save_file(url, dst)
     File.open(dst, 'wb') do |saved_file|
       open(url, 'rb') do |read_file|
@@ -103,28 +115,53 @@ module Flickpaper
     end
   end
 
+  # http://apple.stackexchange.com/questions/200125/how-to-create-an-osx-application-to-wrap-a-call-to-a-shell-script
+  # http://www.hccp.org/command-line-os-x.html
+  # http://osxdaily.com/2015/08/28/set-wallpaper-command-line-macosx/
   def self.set_wallpaper_macosx(path)
-    bash = <<-EOBASH
-      tell application "Finder"
-        set desktop picture to POSIX file "#{path}"
-      end tell
-    EOBASH
-    system(bash)
+    osascript = %x{ which osascript }.to_s.strip
+    if osascript == ""
+      false
+    else
+      bash = <<-EOBASH
+        #{osascript} -e 'tell application "Finder" to set desktop picture to POSIX file "#{path}"'
+      EOBASH
+      system(bash)
+    end
   end
 
   def self.set_wallpaper_linux(path)
-    dbus_launch = %w{ which dbus-launch }.to_s.strip
-    if dbus_launch != ""
+    dbus_launch = %x{ which dbus-launch }.to_s.strip
+    gsettings = %x{ which gsettings }.to_s.strip
+    if dbus_launch == "" || gsettings == ""
+      false
+    else
       # http://dbus.freedesktop.org/doc/dbus-launch.1.html
       bash = <<-EOBASH
         if [ -z "$DBUS_SESSION_BUS_ADDRESS" ]; then
           # if not found, launch a new one
-          eval `dbus-launch --sh-syntax`
+          eval `#{dbus_launch} --sh-syntax`
         fi
 
-        gsettings set org.gnome.desktop.background picture-uri "file://#{path}"
+        #{gsettings} set org.gnome.desktop.background picture-uri "file://#{path}"
       EOBASH
       system(bash)
+    end
+  end
+
+  def self.get_default_image_path
+    case os
+    when :windows
+      false
+    when :macosx
+      home_tmp = File.join(ENV['HOME'], 'tmp')
+      if File.directory?(home_tmp)
+        File.join(home_tmp, "flickpaper-#{ENV['USER']}.jpg")
+      else
+        File.join('/tmp', "flickpaper-#{ENV['USER']}.jpg")
+      end
+    when :linux, :unix
+      File.join(ENV['HOME'], '.flickpaper.jpg')
     else
       false
     end
@@ -144,10 +181,31 @@ module Flickpaper
     log = Logger.new(options[:log] ? options[:log] : STDOUT)
     log.level = options[:verbose] ? Logger::INFO : Logger::ERROR
 
+    size_idx = SIZES.index(options[:size])
+    if size_idx.nil? || size_idx < 0
+      log.error("Invalid size argument: #{options[:size]}.\nPlease select from: #{SIZES.join(', ')}.")
+      exit 1
+    end
+
     Flickpaper.init
 
-    log.info("Getting interesting list")
-    list = Flickpaper.interesting(per_page: 25)
+    opts = options.select { |k,v| [:page, :per_page, :date].include?(k) && !v.nil? }
+    log.info("Getting interesting list: #{opts.inspect}")
+    begin
+      # date (Optional)
+      #   A specific date, formatted as YYYY-MM-DD, to return interesting photos for.
+      # extras (Optional)
+      #   A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_q, url_m, url_n, url_z, url_c, url_l, url_o
+      # per_page (Optional)
+      #   Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.
+      # page (Optional)
+      #   The page of results to return. If this argument is omitted, it defaults to 1.
+      list = flickr.interestingness.getList(opts)
+    rescue FlickRaw::FailedResponse => e
+      log.error("Flickr API error: #{e.message}")
+      exit 1
+    end
+
     ids = Flickpaper.get_ids(options[:dump])
     list = list.select { |l| !ids.include?(l['id']) }
 
@@ -156,8 +214,17 @@ module Flickpaper
 
     log.info("Selecting large photo")
     (0...(list.length)).each do |i|
-      size = flickr.photos.getSizes(photo_id: list[i]['id'])
-      if my_size = size.detect { |s| s['label'] == "Large 2048" }
+      begin
+        size = flickr.photos.getSizes(photo_id: list[i]['id'])
+      rescue FlickRaw::FailedResponse => e
+        log.error("Flickr API error: #{e.message}")
+        exit 1
+      end
+      my_size = size.detect do |s|
+        my_size_idx = SIZES.index(s['label'])
+        !my_size_idx.nil? && my_size_idx >= size_idx
+      end
+      if my_size
         idx = i
         url = my_size['source']
         break

data/version

@@ -1 +1 @@
-0.0.2
+0.0.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flickpaper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andrew Tongen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,50 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |
-  # Flickpaper
-
-  A [Flickr App](https://www.flickr.com/services/apps/72157658406991003) that sets your GNOME wallpaper to a recent interesting photo
-
-  ## Installation
-
-  Install the gem:
-
-  ```shell
-  $ gem install flickpaper
-  ```
-
-  Or add this line to your application's Gemfile:
-
-  ```ruby
-  gem 'flickpaper'
-  ```
-
-  And then execute:
-
-  ```shell
-  $ bundle
-  ```
-
-  ## Usage
-
-  ```shell
-  Usage: $ flickpaper [options]
-      -d, --dump [PATH]                Dump file for used photo ids. Default: $HOME/.flickpaper.dump
-      -i, --image [PATH]               Where to store the downloaded image. Default: $HOME/.flickpaper.jpg
-      -v, --verbose                    Verbose
-          --version                    Show version
-  ```
-
-  Use with cron to periodically get a new interesting desktop wallpaper.
-
-  ## Contributing
-
-  1. Fork it ( https://github.com/atongen/flickpaper/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 a new Pull Request
+description: Sets your GNOME or OSX wallpaper to a recent interesting photo from flickr
 email:
 - atongen@gmail.com
 executables:
@@ -137,6 +94,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Sets your GNOME wallpaper to a recent interesting photo from flickr
+summary: Sets your GNOME or OSX wallpaper to a recent interesting photo from flickr
 test_files: []
-has_rdoc: