flickrchive 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51456d1e49c0615835c700ceb82c37d5919b44b4
+  data.tar.gz: 01ae6f9e4ee296919211bf7246b4bd8e5daba84a
+SHA512:
+  metadata.gz: cbee3679b0c2baed7f0cfbce6affb0945ff88dfb8381fe89a0ecd19976c5d5f94a3b8b18310b16d1ed7fc24e6d3dc159026b146bebb10e9617a6d0a9d0734ecf
+  data.tar.gz: c064d7131645f16f9807f0f8370760dfd385958f9409d84e3e1db45bde70c21bee1cf78b8ee68388d5cf750abe4cb8b2bd5a381a8e6915b2fb9b8c15825a1075

data/LICENSE

@@ -0,0 +1,201 @@
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2015 Steve Nolen
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/bin/flickrchive

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'flickrchive/cli'
+
+Flickrchive::CLI.start(ARGV)

data/flickrchive.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+#require 'ohmage/version'
+
+Gem::Specification.new do |spec|
+  spec.add_dependency 'flickraw', '~> 0.9', '>= 0.9.8'
+  spec.add_dependency 'ruby-filemagic', '~> 0.6', '>= 0.6.3'
+  spec.add_dependency 'daybreak', '~> 0.3', '>= 0.3.0'
+  spec.authors = ['Steve Nolen']
+  spec.description = 'A photo archiver to flickr in ruby'
+  spec.email = %w(technolengy@gmail.com)
+  spec.files = %w(LICENSE flickrchive.gemspec bin/flickrchive) + Dir['lib/**/*.rb']
+  spec.homepage = 'https://github.com/stevenolen/flickrchive'
+  spec.licenses = %w(Apache 2)
+  spec.name = 'flickrchive'
+  spec.executables = 'flickrchive'
+  spec.require_paths = %w(lib)
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_rubygems_version = '>= 1.3.5'
+  spec.summary = spec.description
+  spec.version = '0.0.3'
+end

data/lib/flickrchive/cli.rb

@@ -0,0 +1,20 @@
+require 'thor'
+require 'flickrchive'
+
+module Flickrchive
+  class CLI < Thor
+    class_option :config, :type => :string
+
+    desc 'prep', 'initializes the db, recursively searching directory for photos'
+    def prep
+      f = Flickrchive::Config.new(options[:config])
+      f.prepare
+    end
+
+    desc 'exec', 'attempts to upload photos in db to flickr'
+    def exec
+      f = Flickrchive::Config.new(options[:config])
+      f.run
+    end
+  end
+end

data/lib/flickrchive/config.rb

@@ -0,0 +1,67 @@
+require 'flickrchive/prepare'
+require 'flickrchive/execute'
+require 'yaml'
+require 'daybreak'
+
+module Flickrchive
+  class Config
+    include Flickrchive::Prepare
+    include Flickrchive::Execute
+    attr_accessor :db_file, :directory, :log_level, :log_dir, :username, :db, :sets, :excludes
+
+    def initialize(config_file = nil)
+      begin
+        config = YAML.load_file(config_file || "#{ENV['HOME']}/.flickrchive.yml") 
+        # do i need to keep my flickr api key secret?
+        FlickRaw.api_key = config['api_key']
+        FlickRaw.shared_secret = config['shared_secret']
+        if config['access_token'].nil? || config['access_secret'].nil?
+          config['access_token'], config['access_secret'] = auth
+          File.open("#{ENV['HOME']}/.flickrchive.yml", 'w') { |f| YAML.dump(config, f) }
+        end
+        flickr.access_token = config['access_token']
+        flickr.access_secret = config['access_secret']
+        self.db_file = config['db_file']
+        self.directory = File.join(config['directory'], "") # ensure dir ends in trailing slash
+        self.excludes = config['excludes']
+        init_logger(config)
+        self.username = try_login
+        self.db = Daybreak::DB.new self.db_file
+        Flickrchive.logger.debug("Flickrchive initialized as #{self.username}.")
+        self
+      rescue => e
+          # config step inits logger, just put to STDOUT until we can be sure the logger exists
+          puts e
+          exit
+      end
+    end
+
+    def init_logger(config)
+      log_level = config['log_level'] || 'debug'
+      log_dir = config['log_dir'] || STDOUT
+      Flickrchive.logger = Logger.new(log_dir)
+      Flickrchive.logger.level = Logger.const_get(log_level.upcase)
+    end
+
+    def try_login
+      login = flickr.test.login
+      return login.username
+    end
+
+    def auth
+      token = flickr.get_request_token
+      auth_url = flickr.get_authorize_url(token['oauth_token'], :perms => 'delete')
+      puts "Open this url in your process to complete the authication process : #{auth_url}"
+      puts "Copy here the number given when you complete the process."
+      verify = gets.strip
+      begin
+        flickr.get_access_token(token['oauth_token'], token['oauth_token_secret'], verify)
+        login = flickr.test.login
+        return flickr.access_token, flickr.access_secret
+        #puts "You are now authenticated as #{login.username} with token #{flickr.access_token} and secret #{flickr.access_secret}"
+      rescue FlickRaw::FailedResponse => e
+        puts "Authentication failed : #{e.msg}"
+      end
+    end
+  end
+end

data/lib/flickrchive/execute.rb

@@ -0,0 +1,76 @@
+module Flickrchive
+  module Execute
+    def run
+      get_sets
+      self.db.load
+      self.db.synchronize do
+        self.db.each do |k,v|
+          unless v.has_key?(:flickr_id)
+            upload_photo(v)
+            add_to_set(v)
+          else
+            Flickrchive.logger.debug("Ignoring already uploaded file: #{v[:filename]}")
+          end
+        end
+      end
+      self.db.close
+    end
+
+    def upload_photo(photo)
+      begin
+        id = flickr.upload_photo photo[:filename], is_public: 0, is_friend: 0, is_family: 0, hidden: 2, tags: photo[:tags]
+      rescue FlickRaw::FailedResponse => e
+        handle_flickr_fail(e)
+        retry
+      end
+      Flickrchive.logger.info("Uploaded file: #{photo[:filename]}")
+      photo[:flickr_id] = id
+      self.db.synchronize do
+        self.db[photo[:md5]] = photo
+      end
+    end
+
+    def add_to_set(photo)
+      set = self.sets.find { |i| photo[:set] == i['title'] }
+      if !set.nil?
+        begin
+          flickr.photosets.addPhoto photoset_id: set['id'], photo_id: photo[:flickr_id]
+        rescue FlickRaw::FailedResponse => e
+          handle_flickr_fail(e)
+          retry
+        end
+        Flickrchive.logger.info("Photo added to set: #{photo[:filename]}, #{photo[:set]}")
+      elsif photo[:set] == ''
+        Flickrchive.logger.debug("Photo in base, not adding to set: #{photo[:filename]}")
+      else
+        begin
+          flickr.photosets.create title: photo[:set], primary_photo_id: photo[:flickr_id]
+        rescue FlickRaw::FailedResponse => e
+          handle_flickr_fail(e)
+          retry
+        end
+        Flickrchive.logger.info("Created set, added photo: #{photo[:set]}, #{photo[:filename]}")
+        get_sets # refresh for new set
+      end
+    end
+
+    def get_sets
+      begin
+        self.sets = flickr.photosets.getList
+      rescue FlickRaw::FailedResponse => e
+        handle_flickr_fail(e)
+        retry
+      end
+    end
+
+    def handle_flickr_fail(e)
+      if [3, 105, 106].include?(e.code)
+        sleep 60 # sleep 60, returning to code which will retry
+      else
+        Flickrchive.logger.fail("Uncatchable response from flickr. Check and restart: #{e.msg}")
+        self.db.close
+        exit
+      end
+    end
+  end
+end

data/lib/flickrchive/prepare.rb

@@ -0,0 +1,61 @@
+require 'filemagic'
+require 'digest'
+require 'rake' # for FileList
+
+module Flickrchive
+  module Prepare
+    def prepare
+      fm = FileMagic.new
+      files = FileList.new("#{self.directory}/**/*") do |fl|
+        self.excludes.each do |exclude_matcher|
+          fl.exclude(Regexp.new(exclude_matcher))
+        end
+      end
+
+      files.each do |fn|
+        new_photo = {filename: fn}
+        begin
+          new_photo[:type] = fm.file(fn)
+          case new_photo[:type]
+          when /^JPEG/, /^PNG/, /^GIF/
+            create_file_metadata(new_photo)
+            add_to_db(new_photo)
+          else
+            Flickrchive.logger.debug("Ignoring non-photo file: #{fn}")
+          end
+        rescue FileMagic::FileMagicError
+          Flickrchive.logger.warn("FileMagic explosion, ignoring file: #{fn}")
+        rescue Errno::ENOENT
+          Flickrchive.logger.warn("File no longer exists: #{fn}")
+        end
+      end
+    end
+
+    def add_to_db(photo)
+      if self.db.keys.include? photo[:md5]
+        Flickrchive.logger.debug("Ignoring previously added file #{photo[:filename]}")
+      else
+        self.db.synchronize do
+          db[photo[:md5]] = photo
+        end
+        Flickrchive.logger.debug("Added photo: #{photo[:filename]}")
+      end
+    end
+
+    def create_file_metadata(photo)
+      photo[:md5] = Digest::MD5.file(photo[:filename]).hexdigest
+      photo[:path_arr], photo[:tags] = photo_arrays(photo[:filename])
+      photo[:set] = photo[:path_arr][-2] || '' # files in base dir get blank set
+      photo[:name] = photo[:path_arr].last
+    end
+
+    def photo_arrays(fn)
+      path_arr = fn.sub(self.directory, '').split('/')
+      path_arr.delete("")
+      tags_arr = path_arr.collect { |x| x.gsub(' ', '') }
+      _filename = tags_arr.pop #pop off the filename, no need to have that as a tag
+      tags = tags_arr.join(" ")
+      return path_arr, tags
+    end
+  end
+end

data/lib/flickrchive.rb

@@ -0,0 +1,11 @@
+require 'flickraw'
+require 'flickrchive/config'
+require 'flickrchive/prepare'
+require 'flickrchive/execute'
+require 'logger'
+
+module Flickrchive
+  class <<self
+    attr_accessor :logger
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: flickrchive
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Steve Nolen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+- !ruby/object:Gem::Dependency
+  name: ruby-filemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: daybreak
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: A photo archiver to flickr in ruby
+email:
+- technolengy@gmail.com
+executables:
+- flickrchive
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- bin/flickrchive
+- flickrchive.gemspec
+- lib/flickrchive.rb
+- lib/flickrchive/cli.rb
+- lib/flickrchive/config.rb
+- lib/flickrchive/execute.rb
+- lib/flickrchive/prepare.rb
+homepage: https://github.com/stevenolen/flickrchive
+licenses:
+- Apache
+- '2'
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: A photo archiver to flickr in ruby
+test_files: []
+has_rdoc: