twitter-avatar-update 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ lib/**/*.rb
2
+ bin/*
3
+ -
4
+ features/**/*.feature
5
+ LICENSE.txt
data/Gemfile ADDED
@@ -0,0 +1,16 @@
1
+ source "http://rubygems.org"
2
+ # Add dependencies required to use your gem here.
3
+ # Example:
4
+ # gem "activesupport", ">= 2.3.5"
5
+ gem 'twitter_oauth'
6
+ gem 'oauth'
7
+ gem 'nokogiri'
8
+
9
+ # Add dependencies to develop your gem here.
10
+ # Include everything needed to run rake, tests, features, etc.
11
+ group :development do
12
+ gem "shoulda", ">= 0"
13
+ gem "bundler", "~> 1.0.0"
14
+ gem "jeweler", "~> 1.6.4"
15
+ gem "rcov", ">= 0"
16
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,31 @@
1
+ GEM
2
+ remote: http://rubygems.org/
3
+ specs:
4
+ git (1.2.5)
5
+ jeweler (1.6.4)
6
+ bundler (~> 1.0)
7
+ git (>= 1.2.5)
8
+ rake
9
+ json (1.6.1)
10
+ mime-types (1.16)
11
+ nokogiri (1.5.0)
12
+ oauth (0.4.5)
13
+ rake (0.9.2)
14
+ rcov (0.9.10)
15
+ shoulda (2.11.3)
16
+ twitter_oauth (0.4.3)
17
+ json (>= 1.1.9)
18
+ mime-types (>= 1.16)
19
+ oauth (>= 0.4.1)
20
+
21
+ PLATFORMS
22
+ ruby
23
+
24
+ DEPENDENCIES
25
+ bundler (~> 1.0.0)
26
+ jeweler (~> 1.6.4)
27
+ nokogiri
28
+ oauth
29
+ rcov
30
+ shoulda
31
+ twitter_oauth
data/LICENSE.txt ADDED
@@ -0,0 +1,64 @@
1
+ License
2
+
3
+ THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
4
+
5
+ BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
6
+
7
+ 1. Definitions
8
+
9
+ "Adaptation" means a work based upon the Work, or upon the Work and other pre-existing works, such as a translation, adaptation, derivative work, arrangement of music or other alterations of a literary or artistic work, or phonogram or performance and includes cinematographic adaptations or any other form in which the Work may be recast, transformed, or adapted including in any form recognizably derived from the original, except that a work that constitutes a Collection will not be considered an Adaptation for the purpose of this License. For the avoidance of doubt, where the Work is a musical work, performance or phonogram, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered an Adaptation for the purpose of this License.
10
+ "Collection" means a collection of literary or artistic works, such as encyclopedias and anthologies, or performances, phonograms or broadcasts, or other works or subject matter other than works listed in Section 1(g) below, which, by reason of the selection and arrangement of their contents, constitute intellectual creations, in which the Work is included in its entirety in unmodified form along with one or more other contributions, each constituting separate and independent works in themselves, which together are assembled into a collective whole. A work that constitutes a Collection will not be considered an Adaptation (as defined above) for the purposes of this License.
11
+ "Distribute" means to make available to the public the original and copies of the Work or Adaptation, as appropriate, through sale or other transfer of ownership.
12
+ "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, Noncommercial, ShareAlike.
13
+ "Licensor" means the individual, individuals, entity or entities that offer(s) the Work under the terms of this License.
14
+ "Original Author" means, in the case of a literary or artistic work, the individual, individuals, entity or entities who created the Work or if no individual or entity can be identified, the publisher; and in addition (i) in the case of a performance the actors, singers, musicians, dancers, and other persons who act, sing, deliver, declaim, play in, interpret or otherwise perform literary or artistic works or expressions of folklore; (ii) in the case of a phonogram the producer being the person or legal entity who first fixes the sounds of a performance or other sounds; and, (iii) in the case of broadcasts, the organization that transmits the broadcast.
15
+ "Work" means the literary and/or artistic work offered under the terms of this License including without limitation any production in the literary, scientific and artistic domain, whatever may be the mode or form of its expression including digital form, such as a book, pamphlet and other writing; a lecture, address, sermon or other work of the same nature; a dramatic or dramatico-musical work; a choreographic work or entertainment in dumb show; a musical composition with or without words; a cinematographic work to which are assimilated works expressed by a process analogous to cinematography; a work of drawing, painting, architecture, sculpture, engraving or lithography; a photographic work to which are assimilated works expressed by a process analogous to photography; a work of applied art; an illustration, map, plan, sketch or three-dimensional work relative to geography, topography, architecture or science; a performance; a broadcast; a phonogram; a compilation of data to the extent it is protected as a copyrightable work; or a work performed by a variety or circus performer to the extent it is not otherwise considered a literary or artistic work.
16
+ "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
17
+ "Publicly Perform" means to perform public recitations of the Work and to communicate to the public those public recitations, by any means or process, including by wire or wireless means or public digital performances; to make available to the public Works in such a way that members of the public may access these Works from a place and at a place individually chosen by them; to perform the Work to the public by any means or process and the communication to the public of the performances of the Work, including by public digital performance; to broadcast and rebroadcast the Work by any means including signs, sounds or images.
18
+ "Reproduce" means to make copies of the Work by any means including without limitation by sound or visual recordings and the right of fixation and reproducing fixations of the Work, including storage of a protected performance or phonogram in digital form or other electronic medium.
19
+
20
+ 2. Fair Dealing Rights. Nothing in this License is intended to reduce, limit, or restrict any uses free from copyright or rights arising from limitations or exceptions that are provided for in connection with the copyright protection under copyright law or other applicable laws.
21
+
22
+ 3. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:
23
+
24
+ to Reproduce the Work, to incorporate the Work into one or more Collections, and to Reproduce the Work as incorporated in the Collections;
25
+ to create and Reproduce Adaptations provided that any such Adaptation, including any translation in any medium, takes reasonable steps to clearly label, demarcate or otherwise identify that changes were made to the original Work. For example, a translation could be marked "The original work was translated from English to Spanish," or a modification could indicate "The original work has been modified.";
26
+ to Distribute and Publicly Perform the Work including as incorporated in Collections; and,
27
+ to Distribute and Publicly Perform Adaptations.
28
+
29
+ The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. Subject to Section 8(f), all rights not expressly granted by Licensor are hereby reserved, including but not limited to the rights described in Section 4(e).
30
+
31
+ 4. Restrictions. The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:
32
+
33
+ You may Distribute or Publicly Perform the Work only under the terms of this License. You must include a copy of, or the Uniform Resource Identifier (URI) for, this License with every copy of the Work You Distribute or Publicly Perform. You may not offer or impose any terms on the Work that restrict the terms of this License or the ability of the recipient of the Work to exercise the rights granted to that recipient under the terms of the License. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties with every copy of the Work You Distribute or Publicly Perform. When You Distribute or Publicly Perform the Work, You may not impose any effective technological measures on the Work that restrict the ability of a recipient of the Work from You to exercise the rights granted to that recipient under the terms of the License. This Section 4(a) applies to the Work as incorporated in a Collection, but this does not require the Collection apart from the Work itself to be made subject to the terms of this License. If You create a Collection, upon notice from any Licensor You must, to the extent practicable, remove from the Collection any credit as required by Section 4(d), as requested. If You create an Adaptation, upon notice from any Licensor You must, to the extent practicable, remove from the Adaptation any credit as required by Section 4(d), as requested.
34
+ You may Distribute or Publicly Perform an Adaptation only under: (i) the terms of this License; (ii) a later version of this License with the same License Elements as this License; (iii) a Creative Commons jurisdiction license (either this or a later license version) that contains the same License Elements as this License (e.g., Attribution-NonCommercial-ShareAlike 3.0 US) ("Applicable License"). You must include a copy of, or the URI, for Applicable License with every copy of each Adaptation You Distribute or Publicly Perform. You may not offer or impose any terms on the Adaptation that restrict the terms of the Applicable License or the ability of the recipient of the Adaptation to exercise the rights granted to that recipient under the terms of the Applicable License. You must keep intact all notices that refer to the Applicable License and to the disclaimer of warranties with every copy of the Work as included in the Adaptation You Distribute or Publicly Perform. When You Distribute or Publicly Perform the Adaptation, You may not impose any effective technological measures on the Adaptation that restrict the ability of a recipient of the Adaptation from You to exercise the rights granted to that recipient under the terms of the Applicable License. This Section 4(b) applies to the Adaptation as incorporated in a Collection, but this does not require the Collection apart from the Adaptation itself to be made subject to the terms of the Applicable License.
35
+ You may not exercise any of the rights granted to You in Section 3 above in any manner that is primarily intended for or directed toward commercial advantage or private monetary compensation. The exchange of the Work for other copyrighted works by means of digital file-sharing or otherwise shall not be considered to be intended for or directed toward commercial advantage or private monetary compensation, provided there is no payment of any monetary compensation in con-nection with the exchange of copyrighted works.
36
+ If You Distribute, or Publicly Perform the Work or any Adaptations or Collections, You must, unless a request has been made pursuant to Section 4(a), keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or if the Original Author and/or Licensor designate another party or parties (e.g., a sponsor institute, publishing entity, journal) for attribution ("Attribution Parties") in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; (ii) the title of the Work if supplied; (iii) to the extent reasonably practicable, the URI, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and, (iv) consistent with Section 3(b), in the case of an Adaptation, a credit identifying the use of the Work in the Adaptation (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). The credit required by this Section 4(d) may be implemented in any reasonable manner; provided, however, that in the case of a Adaptation or Collection, at a minimum such credit will appear, if a credit for all contributing authors of the Adaptation or Collection appears, then as part of these credits and in a manner at least as prominent as the credits for the other contributing authors. For the avoidance of doubt, You may only use the credit required by this Section for the purpose of attribution in the manner set out above and, by exercising Your rights under this License, You may not implicitly or explicitly assert or imply any connection with, sponsorship or endorsement by the Original Author, Licensor and/or Attribution Parties, as appropriate, of You or Your use of the Work, without the separate, express prior written permission of the Original Author, Licensor and/or Attribution Parties.
37
+
38
+ For the avoidance of doubt:
39
+ Non-waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme cannot be waived, the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License;
40
+ Waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme can be waived, the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License if Your exercise of such rights is for a purpose or use which is otherwise than noncommercial as permitted under Section 4(c) and otherwise waives the right to collect royalties through any statutory or compulsory licensing scheme; and,
41
+ Voluntary License Schemes. The Licensor reserves the right to collect royalties, whether individually or, in the event that the Licensor is a member of a collecting society that administers voluntary licensing schemes, via that society, from any exercise by You of the rights granted under this License that is for a purpose or use which is otherwise than noncommercial as permitted under Section 4(c).
42
+ Except as otherwise agreed in writing by the Licensor or as may be otherwise permitted by applicable law, if You Reproduce, Distribute or Publicly Perform the Work either by itself or as part of any Adaptations or Collections, You must not distort, mutilate, modify or take other derogatory action in relation to the Work which would be prejudicial to the Original Author's honor or reputation. Licensor agrees that in those jurisdictions (e.g. Japan), in which any exercise of the right granted in Section 3(b) of this License (the right to make Adaptations) would be deemed to be a distortion, mutilation, modification or other derogatory action prejudicial to the Original Author's honor and reputation, the Licensor will waive or not assert, as appropriate, this Section, to the fullest extent permitted by the applicable national law, to enable You to reasonably exercise Your right under Section 3(b) of this License (right to make Adaptations) but not otherwise.
43
+
44
+ 5. Representations, Warranties and Disclaimer
45
+
46
+ UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING AND TO THE FULLEST EXTENT PERMITTED BY APPLICABLE LAW, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO THIS EXCLUSION MAY NOT APPLY TO YOU.
47
+
48
+ 6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
49
+
50
+ 7. Termination
51
+
52
+ This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Adaptations or Collections from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
53
+ Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.
54
+
55
+ 8. Miscellaneous
56
+
57
+ Each time You Distribute or Publicly Perform the Work or a Collection, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
58
+ Each time You Distribute or Publicly Perform an Adaptation, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
59
+ If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
60
+ No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
61
+ This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.
62
+ The rights granted under, and the subject matter referenced, in this License were drafted utilizing the terminology of the Berne Convention for the Protection of Literary and Artistic Works (as amended on September 28, 1979), the Rome Convention of 1961, the WIPO Copyright Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and the Universal Copyright Convention (as revised on July 24, 1971). These rights and subject matter take effect in the relevant jurisdiction in which the License terms are sought to be enforced according to the corresponding provisions of the implementation of those treaty provisions in the applicable national law. If the standard suite of rights granted under applicable copyright law includes additional rights not granted under this License, such additional rights are deemed to be included in the License; this License is not intended to restrict the license of any rights under applicable law.
63
+
64
+
data/README.rdoc ADDED
@@ -0,0 +1,19 @@
1
+ = twitter-avatar-update
2
+
3
+ Description goes here.
4
+
5
+ == Contributing to twitter-avatar-update
6
+
7
+ * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
8
+ * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
9
+ * Fork the project
10
+ * Start a feature/bugfix branch
11
+ * Commit and push until you are happy with your contribution
12
+ * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
13
+ * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
14
+
15
+ == Copyright
16
+
17
+ Copyright (c) 2011 ip2k. See LICENSE.txt for
18
+ further details.
19
+
data/Rakefile ADDED
@@ -0,0 +1,60 @@
1
+ # encoding: utf-8
2
+
3
+ require 'rubygems'
4
+ require 'bundler'
5
+ begin
6
+ Bundler.setup(:default, :development)
7
+ rescue Bundler::BundlerError => e
8
+ $stderr.puts e.message
9
+ $stderr.puts "Run `bundle install` to install missing gems"
10
+ exit e.status_code
11
+ end
12
+ require 'rake'
13
+
14
+ require 'jeweler'
15
+ Jeweler::Tasks.new do |gem|
16
+ # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
17
+
18
+ gem.name = "twitter-avatar-update"
19
+ gem.add_dependency 'oauth'
20
+ gem.add_dependency 'twitter_oauth'
21
+ gem.add_dependency 'nokogiri'
22
+ gem.executables = ['twitter-avatar-update']
23
+ gem.homepage = "http://github.com/ip2k/twitter-avatar-update"
24
+ gem.license = "Creative Commons by-nc-sa"
25
+ gem.summary = "Updates your Twitter avatar to a random user-created avatar"
26
+ gem.description = "Updates your Twitter avatar to a random user-created avatar from http://eightshit.me"
27
+ gem.email = "github@seanp2k.endjunk.com"
28
+ gem.authors = ["ip2k"]
29
+
30
+
31
+ # dependencies defined in Gemfile
32
+ end
33
+ Jeweler::RubygemsDotOrgTasks.new
34
+
35
+ require 'rake/testtask'
36
+ Rake::TestTask.new(:test) do |test|
37
+ test.libs << 'lib' << 'test'
38
+ test.pattern = 'test/**/test_*.rb'
39
+ test.verbose = true
40
+ end
41
+
42
+ require 'rcov/rcovtask'
43
+ Rcov::RcovTask.new do |test|
44
+ test.libs << 'test'
45
+ test.pattern = 'test/**/test_*.rb'
46
+ test.verbose = true
47
+ test.rcov_opts << '--exclude "gems/*"'
48
+ end
49
+
50
+ task :default => :test
51
+
52
+ require 'rake/rdoctask'
53
+ Rake::RDocTask.new do |rdoc|
54
+ version = File.exist?('VERSION') ? File.read('VERSION') : ""
55
+
56
+ rdoc.rdoc_dir = 'rdoc'
57
+ rdoc.title = "twitter-avatar-update #{version}"
58
+ rdoc.rdoc_files.include('README*')
59
+ rdoc.rdoc_files.include('lib/**/*.rb')
60
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.1.0
@@ -0,0 +1,180 @@
1
+ #!/usr/bin/env ruby
2
+ # ==== Gems ====
3
+ require 'twitter_oauth'
4
+ require 'oauth'
5
+ require 'nokogiri'
6
+ require 'open-uri'
7
+ require 'yaml'
8
+
9
+ # ==== Global Vars ====
10
+ # full path to our YAML config file. We'll take care of setting up the directory and stuff later.
11
+ $CONFIG_FILE = File.expand_path( '~/.eightshit-avatar-update/config.yaml' )
12
+
13
+ # project homepage URL so people can file bug reports.
14
+ $PROJECT_HOMEPAGE = 'https://github.com/ip2k/twitter-avatar-update'
15
+
16
+ # ==== Functions ====
17
+ def load_config(full_path)
18
+ begin
19
+ return YAML::load_file(full_path)
20
+ rescue
21
+ abort "Can't read file: #{full_path_to_config_file}. Maybe you don't have access to read it or the file doesn't exist (file a bug report at #{$PROJECT_HOMEPAGE} in this case)?"
22
+ end
23
+ end
24
+
25
+ def create_default_config_file(full_path_to_config_file)
26
+ # create our directory if it doesn't exist.
27
+ # abort if we can't create the directory
28
+ begin
29
+ config_dir = File.dirname( full_path_to_config_file ) # get the absolute path to the config file
30
+ config_filename = File.basename( full_path_to_config_file ) # get the actual file name since it should be the last element and cast it to a string
31
+ Dir.mkdir( config_dir ) unless File::directory?( config_dir )
32
+ rescue
33
+ abort "Can't create directory: #{config_dir}. Maybe it's already a file or exists but isn't writable by you?"
34
+ end
35
+
36
+ # create our YAML config file and populate it with all the stuff we'll eventually save back to it
37
+ # abort if we can't create this file
38
+ begin
39
+ my_config = Hash.new
40
+ my_config['oauth'] = Hash.new
41
+ my_config['oauth']['consumer_key'] = '3LNaD1KM1s8TNgH5CBWBDA'
42
+ my_config['oauth']['consumer_secret'] = 'jEP4tpHKXUZaZJrxhrgj2E2Q3SShgGvZnflPCFMA3A'
43
+ #my_config['oauth']['access_token'] = false
44
+ #my_config['oauth']['access_secret'] = false
45
+ File.open(full_path_to_config_file, 'w') do |out|
46
+ YAML::dump( my_config, out )
47
+ end
48
+ rescue
49
+ abort "Can't create/modify default config file: #{full_path_to_config_file}. Maybe it's already a file or exists but isn't writable by you?"
50
+ end
51
+ end
52
+
53
+ def save_config_file(myconfig, full_path_to_config_file)
54
+ # note that you need to update the config hash OUTSIDE of this and just pass
55
+ begin
56
+ YAML::dump(myconfig, File.open(full_path_to_config_file, 'w'))
57
+ rescue
58
+ abort "Can't create/modify file that I'm trying to save: #{full_path_to_config_file}. Maybe it's already a file or exists but isn't writable by you?"
59
+ end
60
+ end
61
+
62
+ def get_access_token(consumer_key, consumer_secret)
63
+ # returns: access token and secret as a 2-item list
64
+ # you should probably do like access_token, access_secret = get_access_token
65
+ # WARNING: this blocks while the user opens a browser and logs in to twitter.
66
+ consumer = OAuth::Consumer.new consumer_key, consumer_secret,
67
+ { :site => 'http://twitter.com/',
68
+ :request_token_path => '/oauth/request_token',
69
+ :access_token_path => '/oauth/access_token',
70
+ :authorize_path => '/oauth/authorize'}
71
+ request_token = consumer.get_request_token
72
+ puts "OK!"
73
+ print "Visit \"#{request_token.authorize_url}\" with your web browser and authorize this app, then enter the PIN displayed: "
74
+ pin = STDIN.gets.strip
75
+ print "Thanks! Now, hang tight while I send this back to twitter for verification..."
76
+ access_token = request_token.get_access_token(:oauth_verifier => pin)
77
+ return access_token.token, access_token.secret
78
+ end
79
+
80
+ def reuse_token(config)
81
+ # note that config must be a populated config array read from the YAML config file
82
+ begin
83
+ client = TwitterOAuth::Client.new(
84
+ :consumer_key => config['oauth']['consumer_key'],
85
+ :consumer_secret => config['oauth']['consumer_secret'],
86
+ :token => config['oauth']['access_token'],
87
+ :secret => config['oauth']['access_secret']
88
+ )
89
+ rescue
90
+ abort "Couldn't establish an API connect to Twitter. Maybe you need to delete your config YAML and re-do the OAuth dance, or maybe you don't have an internet connection?"
91
+ end
92
+ return client
93
+ end
94
+
95
+ def get_new_avatar()
96
+ # this function CREATES the local array 'avatars'...
97
+ # and populates it with the EightShit.me avatar image URLs from Page 1
98
+ avatar_urls = Array.new #create the new global array $avatars
99
+ avatar_filename = "avatar-#{Time.now.to_i.to_s}.png" # generate a filename that is hopefully unique (nix timestamp format)
100
+
101
+ doc = Nokogiri::HTML( open( 'http://eightshit.me/' ) ) # open the eightshit.me page as DOM so we can parse it
102
+ doc.xpath( '/html/body/ul/li/a/img' ).each do |node| # use xpath to get each image
103
+ avatar_urls.push( "http://eightshit.me#{node['src']}" ) # push the image source URL onto the avatars array
104
+ end
105
+
106
+ single_avatar_url = avatar_urls[rand( avatar_urls.size )] # get a random avatar source URL
107
+
108
+ #TODO make the following block less confusing
109
+ open( single_avatar_url ) do |src| # open the avatar URL
110
+ open( avatar_filename, "wb" ) do |dst| # open the local file we're saving the avatar to
111
+ dst.write( src.read ) # read from the internet and write to the local avatar file
112
+ end
113
+ end
114
+
115
+ puts "Downloaded #{single_avatar_url} as #{avatar_filename}"
116
+ return open( avatar_filename, "r" ) # return a file object with our shiny new avatar
117
+ end
118
+
119
+
120
+ # ==== Main ====
121
+ # if the config YAML is there, just load it.
122
+ # if the config YAML is not there, create a default one (which won't have an access_token or access_secret, but we'll fix that later on), then load it.
123
+ if File.exists?( $CONFIG_FILE ) # the logic here is easy enough to follow that it shouldn't really require further granular explanation.
124
+ print "Found an existing config file that I'll try to load for you: #{$CONFIG_FILE} ..."
125
+ config = load_config( $CONFIG_FILE )
126
+ puts "Loaded #{$CONFIG_FILE} !" if config
127
+ else
128
+ print "No existing config file found, so I'll make you one and call it: #{$CONFIG_FILE} ..."
129
+ create_default_config_file( $CONFIG_FILE )
130
+ print "Now that I made a default config file for you, I'll load it up..."
131
+ config = load_config( $CONFIG_FILE )
132
+ puts "Loaded #{$CONFIG_FILE} !" if config
133
+ end
134
+
135
+ # here is the "later on" where we're testing for an access_token and access_secret.
136
+ if config['oauth']['access_token'].nil? or config['oauth']['access_secret'].nil? # if both the request token and secret are empty, get a new access token
137
+ print "I loaded #{$CONFIG_FILE} , but it didn't have all the OAuth info I need, so we'll need to fix that now.\nFetching a request token from Twitter..."
138
+ # === no access token or no secret block ===
139
+ config['oauth']['access_token'], config['oauth']['access_secret'] = get_access_token( config['oauth']['consumer_key'], config['oauth']['consumer_secret'] )
140
+ puts "OK!\nI'll save your OAuth info to #{$CONFIG_FILE} so you don't have to re-authorize this app." if config['oauth']['access_token'] and config['oauth']['access_secret']
141
+ print "Saving your OAuth info to #{$CONFIG_FILE}..."
142
+ save_config_file( config, $CONFIG_FILE ) # and now since we have config populated we don't need to reload it.
143
+ puts "OK!"
144
+ end
145
+
146
+ # instantiate our Twitter API handle by "re-using" the access_token and access_secret (even if we technically just acquired them above)
147
+ print "Connecting to the Twitter API..."
148
+ twitter = reuse_token( config )
149
+ unless twitter.authorized? # check to make sure we're auth'd
150
+ abort("Twitter API not authorized. Please remove #{$CONFIG_FILE} and re-start me!" ) # if we're not auth'd, just instruct the user to delete the config YAML and re-try everything.
151
+ # this is kinda a cheat, but a lot less complex than elegantly handling this error.
152
+ else
153
+ puts "OK!"
154
+ end
155
+
156
+ # check on our rate limit and fail if we're out of API queries.
157
+ print "Checking on your Twitter API rate limit status..."
158
+ rate_limit_resp = twitter.rate_limit_status
159
+ native_api_reset_time = Time.parse( rate_limit_resp['reset_time'] ) # get the time that the API returns. The API returns UTC, so we need to parse that
160
+ local_api_reset_time = native_api_reset_time.to_time # parse the API time into local time so our user doesn't have to do tz conversions in their head :)
161
+
162
+ unless rate_limit_resp['remaining_hits'].to_i >= 1 # make sure we have at least one remaining hit on the API
163
+ abort( "API rate limit exceeded. Please try again at #{local_api_reset_time} , which is when Twitter told me that your rate limit resets. Your hourly limit is currently #{rate_limit_resp['hourly_limit']}" )
164
+ end
165
+ puts "OK! (FYI, Twitter says that you have #{rate_limit_resp['remaining_hits']}/#{rate_limit_resp['hourly_limit']} API hits left until #{local_api_reset_time})"
166
+
167
+ print "Now it's time to download a shiny new avatar for you from http://eightshit.me ..."
168
+ avatar = get_new_avatar() # download and save our avatar from eightshit.me. 'avatar' is a file object.
169
+
170
+ unless avatar.is_a? File # make sure that the avatar returned by 'get_new_avatar' is actually a file object
171
+ abort( "Avatar download failed for some reason. This could be because you don't have a proper internet connection, or because eightshit.me changed their HTML layout. Please open a bug in the second case at #{$PROJECT_HOMEPAGE}" )
172
+ end
173
+
174
+ print "Now I'm going to update your Twitter avatar..."
175
+ resp = twitter.update_profile_image( avatar ) # call the Twitter API method to update our profile avatar.
176
+ unless resp.is_a? Hash
177
+ abort( "The Twitter API response when I tried to update your avatar wasn't what I expected it to be. This could be because the Twitter API is having issues or because your internet connection isn't solid. Please check out https://dev.twitter.com/status and make sure that it's not just the Twitter API having issues before filing a bug report at #{$PROJECT_HOMEPAGE} ." )
178
+ end
179
+ puts "OK!\nCheck out https://twitter.com/#{resp['screen_name']} to see your new avatar!"
180
+ # TODO: refactor OAuth code, possibly break into a module to handle so we can re-use
File without changes
metadata ADDED
@@ -0,0 +1,170 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: twitter-avatar-update
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - ip2k
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2011-09-27 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: twitter_oauth
16
+ requirement: &71192440 !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ! '>='
20
+ - !ruby/object:Gem::Version
21
+ version: '0'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: *71192440
25
+ - !ruby/object:Gem::Dependency
26
+ name: oauth
27
+ requirement: &71191770 !ruby/object:Gem::Requirement
28
+ none: false
29
+ requirements:
30
+ - - ! '>='
31
+ - !ruby/object:Gem::Version
32
+ version: '0'
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: *71191770
36
+ - !ruby/object:Gem::Dependency
37
+ name: nokogiri
38
+ requirement: &71190970 !ruby/object:Gem::Requirement
39
+ none: false
40
+ requirements:
41
+ - - ! '>='
42
+ - !ruby/object:Gem::Version
43
+ version: '0'
44
+ type: :runtime
45
+ prerelease: false
46
+ version_requirements: *71190970
47
+ - !ruby/object:Gem::Dependency
48
+ name: shoulda
49
+ requirement: &71190370 !ruby/object:Gem::Requirement
50
+ none: false
51
+ requirements:
52
+ - - ! '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ type: :development
56
+ prerelease: false
57
+ version_requirements: *71190370
58
+ - !ruby/object:Gem::Dependency
59
+ name: bundler
60
+ requirement: &71189230 !ruby/object:Gem::Requirement
61
+ none: false
62
+ requirements:
63
+ - - ~>
64
+ - !ruby/object:Gem::Version
65
+ version: 1.0.0
66
+ type: :development
67
+ prerelease: false
68
+ version_requirements: *71189230
69
+ - !ruby/object:Gem::Dependency
70
+ name: jeweler
71
+ requirement: &71188160 !ruby/object:Gem::Requirement
72
+ none: false
73
+ requirements:
74
+ - - ~>
75
+ - !ruby/object:Gem::Version
76
+ version: 1.6.4
77
+ type: :development
78
+ prerelease: false
79
+ version_requirements: *71188160
80
+ - !ruby/object:Gem::Dependency
81
+ name: rcov
82
+ requirement: &71186250 !ruby/object:Gem::Requirement
83
+ none: false
84
+ requirements:
85
+ - - ! '>='
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ type: :development
89
+ prerelease: false
90
+ version_requirements: *71186250
91
+ - !ruby/object:Gem::Dependency
92
+ name: oauth
93
+ requirement: &71185160 !ruby/object:Gem::Requirement
94
+ none: false
95
+ requirements:
96
+ - - ! '>='
97
+ - !ruby/object:Gem::Version
98
+ version: '0'
99
+ type: :runtime
100
+ prerelease: false
101
+ version_requirements: *71185160
102
+ - !ruby/object:Gem::Dependency
103
+ name: twitter_oauth
104
+ requirement: &71184570 !ruby/object:Gem::Requirement
105
+ none: false
106
+ requirements:
107
+ - - ! '>='
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ type: :runtime
111
+ prerelease: false
112
+ version_requirements: *71184570
113
+ - !ruby/object:Gem::Dependency
114
+ name: nokogiri
115
+ requirement: &71183610 !ruby/object:Gem::Requirement
116
+ none: false
117
+ requirements:
118
+ - - ! '>='
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ type: :runtime
122
+ prerelease: false
123
+ version_requirements: *71183610
124
+ description: Updates your Twitter avatar to a random user-created avatar from http://eightshit.me
125
+ email: github@seanp2k.endjunk.com
126
+ executables:
127
+ - twitter-avatar-update
128
+ extensions: []
129
+ extra_rdoc_files:
130
+ - LICENSE.txt
131
+ - README.rdoc
132
+ files:
133
+ - .document
134
+ - Gemfile
135
+ - Gemfile.lock
136
+ - LICENSE.txt
137
+ - README.rdoc
138
+ - Rakefile
139
+ - VERSION
140
+ - bin/twitter-avatar-update
141
+ - lib/twitter-avatar-update.rb
142
+ homepage: http://github.com/ip2k/twitter-avatar-update
143
+ licenses:
144
+ - Creative Commons by-nc-sa
145
+ post_install_message:
146
+ rdoc_options: []
147
+ require_paths:
148
+ - lib
149
+ required_ruby_version: !ruby/object:Gem::Requirement
150
+ none: false
151
+ requirements:
152
+ - - ! '>='
153
+ - !ruby/object:Gem::Version
154
+ version: '0'
155
+ segments:
156
+ - 0
157
+ hash: 558877889
158
+ required_rubygems_version: !ruby/object:Gem::Requirement
159
+ none: false
160
+ requirements:
161
+ - - ! '>='
162
+ - !ruby/object:Gem::Version
163
+ version: '0'
164
+ requirements: []
165
+ rubyforge_project:
166
+ rubygems_version: 1.8.5
167
+ signing_key:
168
+ specification_version: 3
169
+ summary: Updates your Twitter avatar to a random user-created avatar
170
+ test_files: []