bingwallpaper 0.5.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTI4MWMxNjg1NzM2NWVjNDMzMDFlMzE3YzlkMmM1ZDVmNDI4ZjgwMw==
+  data.tar.gz: !binary |-
+    MzQ1NGFlNzFkMGQyYzY2ZThlNTQwOTU3Y2UwYmM1ZDhmNzE5Yzc2Yw==
+SHA512:
+  metadata.gz: !binary |-
+    MTcxYjc3Zjc2NDBmNDQ5OTViNzA0YjA2NWNkM2IxMjZiNDMyNzlmNDlkODVl
+    ZjlhMzNmZWY1M2MwYTczZGVmMTk0NTc1Y2FhMzViODJkYzQ0MDIzNTAwZDgz
+    ZjkzMDJkNjUwOWYwNmZlMzdjNGY1NTliYjYzZjhmYzg2YzIyZGY=
+  data.tar.gz: !binary |-
+    OGMzOTYxMDJlNGVjNDBjOGJhNDgzYmRhZDE3ZjVjZjM0OWI3MGFiZTNiOGRh
+    MjUzOTRiMzI1ODIwYjI0ZmI5YzlmODY4NmVlZGUwMWQxNmIzYTNkN2Y3NmQx
+    YWIyODM3NThhMGQxYjllN2RhZjhkM2EzODQxMjIzMzk5ZDk5ZGM=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 cmiles74
+
+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,29 @@
+# Bing Wallpaper
+
+This project provides a simple Ruby script that will download the
+"Image of the Day" from [Bing][0] and then sets it as your current
+wallpaper.
+
+## How It Works
+
+I wrote this script with my own environment in mind, so it's pretty
+simple-minded. It fetches the XML describing today's image, then
+fetches the  1920x1200 sized version. Lastly, it uses [Feh][1] to set
+the wallpaper for your environment. I've tested it in [i3][2] and
+nowhere else.
+
+## Using the Script
+
+Just install the gem...
+
+    gem install bingwallpaper
+
+And then invoke the script.
+
+    bing-wallpaper
+
+
+***
+[0]: https://www/bing.com
+[1]: http://feh.finalrewind.org/
+[2]: http://i3wm.org/

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/bingwallpaper

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+#-*- mode: enh-ruby;-*-
+
+#
+# Sets the desktop wallpaper to the current "image of the day" from the Bing
+# search engine.
+#
+
+require "bingwallpaper"
+
+# create an instance and set the wallpaper
+bingImage = Bingwallpaper::Image.new
+
+# set the wallpaper
+begin
+  bingImage.set_today_wallpaper
+rescue Exception => exception
+  puts "Sorry, I couldn't set today's Bing Imagee of the Day Wallpaper. :'("
+  puts exception.message
+  exit 1
+end

data/bingwallpaper.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bingwallpaper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bingwallpaper"
+  spec.version       = Bingwallpaper::VERSION
+  spec.authors       = ["cmiles74"]
+  spec.email         = ["twitch@nervestaple.com"]
+  spec.summary       = %q{Write a short summary. Required.}
+  spec.description   = %q{Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   << "bingwallpaper"
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/bingwallpaper.rb

@@ -0,0 +1,6 @@
+require "bingwallpaper/version"
+require "bingwallpaper/image"
+
+module Bingwallpaper
+  # Your code goes here...
+end

data/lib/bingwallpaper/image.rb

@@ -0,0 +1,135 @@
+require 'fileutils'
+require 'pathname'
+require 'nokogiri'
+require 'open-uri'
+
+module Bingwallpaper
+
+  #
+  # Provides a class that queries and fetches the Bing "image of the day".
+  #
+  class Image
+
+    # Protocol for accessing Bing
+    PROTO = 'https://'
+
+    # Current Bing domain
+    DOMAIN = 'www.bing.com'
+
+    # Path for the image archive
+    PATH = '/HPImageArchive.aspx'
+
+    # Format for retrieving data
+    FORMAT = 'xml'
+
+    # Default market to fetch
+    DEFAULT_MARKET = 'en-US'
+
+    # Default index to fetch (today)
+    DEFAULT_INDEX = 0
+
+    # Default storage path
+    DEFAULT_STORAGE_PATH = ENV['HOME'] + '/.config/bing_wallpaper'
+
+    # Market to fetch
+    attr_accessor :market
+
+    # index to fetch
+    attr_accessor :index
+
+    # path for storing downloaded images
+    attr_accessor :storage_path
+
+    # Creates a new instance.
+    #
+    # market:: The market to use when fetching
+    # index:: Index of the image to fetch (0 = today)
+    # storage_path:: Path to directory for storing images
+    def initialize(market = DEFAULT_MARKET, index = DEFAULT_INDEX, storage_path = DEFAULT_STORAGE_PATH)
+
+      @market = market
+      @index = index
+      @storage_path = storage_path
+
+      # Ensure the storage path exists
+      FileUtils.mkpath storage_path
+    end
+
+    # Constructs a full path for the provided partial URL.
+    #
+    # partial:: the end of the target URL
+    def build_url(partial)
+
+      return PROTO + DOMAIN + partial
+    end
+
+    # Returns the data URL for the image of the day.
+    def get_data_url
+
+      return build_url(PATH + '?format=' + FORMAT + '&idx=' + @index.to_s + '&n=1' + '&mkt=' + @market)
+    end
+
+    # Parses the XML data and returns a hash of image information.
+    #
+    # url:: complete path to the Bing image of the day
+    def parse_xml(url)
+
+      doc = Nokogiri::HTML(open(url))
+
+      doc.xpath('//images/image').map do |image|
+
+        # figure out the hi-res image path
+        image_path = image.xpath('url').text.sub(image.xpath('url').text.rpartition("_").
+                                                 last, '1920x1200.jpg')
+
+        # build our hash of image data
+        {:links => {:url => build_url(image_path),
+                    :copyright_url => image.xpath('copyrightlink').text},
+            :file_name => Pathname.new(image_path).basename.to_s,
+            :copyright => image.xpath('copyright').text}
+      end
+    end
+
+    # Returns the file location where the image from the provided Bing image
+    # hash will be stored.
+    #
+    # image_data:: Hash of Bing image data
+    def image_storage_path(image_data)
+      @storage_path + "/" + image_data[:file_name]
+    end
+
+    # Downloads the Bing image from the provided image hash.
+    #
+    # image_date:: Hash of Bing image data
+    def download_image(image_data)
+
+      open(image_storage_path(image_data), 'wb') do |file|
+        puts "Downloading: " + image_data[:links][:url]
+        file << open(image_data[:links][:url]).read
+      end
+    end
+
+    # Sets the current wallpaper to the provide File instance.
+    #
+    # file:: File instance with wallpaper data
+    def set_wallpaper(file)
+
+      puts "Setting wallpaper to " + file.path
+      `feh --bg-fill #{file.path}`
+    end
+
+    # Sets the wallpaper to Bing's "image of the day".
+    def set_today_wallpaper
+
+      image_data = parse_xml(get_data_url)
+      image_path = Pathname.new(image_storage_path(image_data[0]))
+
+      # only download the wallpaper once
+      if !image_path.exist?
+        set_wallpaper(download_image(image_data[0]))
+      else
+        puts "Today's wallpaper already downloaded. ;-)"
+      end
+    end
+  end
+end

data/lib/bingwallpaper/version.rb

@@ -0,0 +1,3 @@
+module Bingwallpaper
+  VERSION = "0.5.0"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: bingwallpaper
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- cmiles74
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: Write a longer description. Optional.
+email:
+- twitch@nervestaple.com
+executables:
+- bingwallpaper
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bingwallpaper
+- bingwallpaper.gemspec
+- lib/bingwallpaper.rb
+- lib/bingwallpaper/image.rb
+- lib/bingwallpaper/version.rb
+homepage: ''
+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.2
+signing_key: 
+specification_version: 4
+summary: Write a short summary. Required.
+test_files: []