social_media 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0ab5e277bfddb91ea1d30fa0964344bb7a94a43
-  data.tar.gz: b9ec1d354846101171f776a386ad8033d23eb091
+  metadata.gz: 3645c86fb3100ad97c8d96b815909f4e4efec2f7
+  data.tar.gz: 2fc2e9b44d9ffa04525ce28a67fa0aa96a28e3d4
 SHA512:
-  metadata.gz: f00ffe6626443899f23b7d839a6ec43e276f2dc62ca5fa4f87ed91c95fcd2cf24e8124ec592f891420857c6c01a2d68c23a1f493d616595ecb67fcb494e1c7bc
-  data.tar.gz: 7ea5a155be68519d3134349b146e6a25eef47eb16cb12be975125db598904eeda0b931a5c5eb1f1cb9bff467e54d2316366d8b5acd1f8dcfab99970bc811f48a
+  metadata.gz: 68a239377322773877518168bd6d4ff027b56d732ce70ab7ef3cc5dab65539ab497c424e5eb0f3c1c15cf72119305e8eec03ff2fd4ae6bdb2ce84039b75e0272
+  data.tar.gz: 74c94291b1046b800f5b6c866f27a84b5498ecad11abaf0dbc76a7bf42275f0fb9f6a1564f3ec8a131bca298e96d381d46adfaed8b5eced87604aabc7b7bb8dd

data/README.md

@@ -1,28 +1,65 @@
 # SocialMedia
 
-    Facebook: 1,712,000,000 users
-    WhatsApp 1,000,000,000 users
-    Facebook Messenger: 1,000,000,000 users
-    QQ: 899,000,000 users
-    WeChat: 806,000,000 users
-    QZone: 652,000,000 users
-    Tumblr: 555,000,000 users
-    Instagram: 500,000,000 users
-    Twitter: 313,000,000 users
-    Baidu Tieba: 300,000,000 users
-    Skype: 300,000,000 users
-    Sina Weibo: 282,000,000 users
-    Viber: 249,000,000 users
-    Line: 218,000,000 users
-    Snapchat: 200,000,000 users
-
 ## Usage
 The idea is to treat social media sites like databases.  With that in mind, we'll have adapters for each each social media service
 that we connect, passing the appropriate connection strings to.  Once connected, we can then query and publish to the connection using
 the same method calls and parameters across the various social media services.  Of course some services will have more functionality
 than others.  The library can be configured to silently ignore limited functionality or to explicitly raise errors.
 
+The main objective with this library is to enable centralized maintenance of Profile/Account information across many social media
+services and directory listing sites -- a critical component of local businesses optimizing for Google Maps local results.
+
+Save your credentials in a YAML file (config/services.yml, for example):
+```yaml
+twitter:
+  consumer_key:         'YOUR_CONSUMER_KEY'
+  consumer_secret:      'YOUR_CONSUMER_SECRET'
+  access_token:         'YOUR_ACCESS_TOKEN'
+  access_token_secret:  'YOUR_ACCESS_TOKEN_SECRET'
+
+facebook:
+  app_key:    'YOUR_APP_KEY'
+  app_secret: 'YOUR_APP_SECRET'
+
+# ...
+```
+
+Load and go!
+
+```ruby
+require 'social_media'
+
+def symbolized_keys hash
+  hash.keys.each do |key|
+    hash[(key.to_sym rescue key) || key] = hash.delete(key)
+  end
+  hash.each_pair{|k,v| hash[k] = symbolized_keys(v) if v.is_a?(Hash)}
+  return hash
+end
+
+def service_configurations
+  config_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'config'))
+  @service_configurations ||= symbolized_keys YAML::load_file(File.join(config_path, 'services.yml'))
+end
+
+my_new_avatar_filename = "./images/avatar.png"
+
+service_configurations.each_key do |service_name|
+  options = service_configurations[service_name]
+  options.merge!(not_provided_error: :silent)
+  client = SocialMedia::Service::service(service_name).new options
+  client.send_message "Just Rambling about Social Media"
+  client.upload_profile_avatar my_new_avatar_filename
+end
+```
+
+The above would iterate every service, send a text message and upload a new profile avatar (for the services that support it).
+In the above example, the "not_provided_error: :silent" allows services that do not implement a specific API to silently fail.
+This makes it easy to build an app that updates as many possible profile/account fields without worrying about dealing with
+shortcomings of the library itself.
+
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -40,7 +77,76 @@ $ gem install social_media
 ```
 
 ## Contributing
-Contribution directions go here.
+
+So far, the following have been implemented:
+
+  * Twitter
+  * Facebook (WiP)
+  * Linkedin (WiP)
+  * Google+  (WiP)
+
+The following are planned:
+
+### Social Media Services:
+  * Yahoo
+  * Facebook
+  * Apple
+  * Yelp
+  * WhitePages
+  * Local.com
+  * Foursquare
+
+### Directories:
+  * Google
+  * Bing
+  * MapQuest
+  * Superpages
+  * CitySearch
+  * MerchantCircle
+  * eLocal
+  * Topic
+  * YellowPageCity
+  * LocalStack
+  * ShowMeLocal
+  * EZLocal
+  * WhereTo?
+  * YellowMoxie
+  * CitySquares
+  * LocalDatabase
+  * Yellowise
+
+### Statistics
+
+  * Facebook: 1,712,000,000 users
+  * WhatsApp 1,000,000,000 users
+  * Facebook Messenger: 1,000,000,000 users
+  * QQ: 899,000,000 users
+  * WeChat: 806,000,000 users
+  * QZone: 652,000,000 users
+  * Tumblr: 555,000,000 users
+  * Instagram: 500,000,000 users
+  * Twitter: 313,000,000 users
+  * Baidu Tieba: 300,000,000 users
+  * Skype: 300,000,000 users
+  * Sina Weibo: 282,000,000 users
+  * Viber: 249,000,000 users
+  * Line: 218,000,000 users
+  * Snapchat: 200,000,000 users
+
+## Contributing
+
+This is an open source project.  If you don't see a service implemented that you need, then fork the project, implement, and
+submit your pull request.  Make sure your PR is accompanied by specs, but *don't commit account credentials* to the repo!
+That also means you should never check in your VCR cassettes.  If someone else wants to test a service, they should set up
+their own accounts and generate their own VCR cassettes.
+
+Testing is done by setting up a spec/config/services.yml which has the keyname that matches the new service's name.
+
+You'll need to add a new:
+  * lib/service/new_service.rb
+  * spec/lib/service/new_service_spec.rb
+  * connection credentials to spec/config/services.yml
+  * any gem dependencies for the new service if you use an API/SDK library.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/social_media/errors.rb

@@ -1,5 +1,4 @@
 module SocialMedia
-
   def self.convert_exception_class exception, klass
     return exception if exception.is_a?(klass)
     e = klass.new("#{exception.class}: #{exception.message}")
@@ -16,4 +15,7 @@ module SocialMedia
 
   Unauthorized = Class.new(Error)
   Error::Unauthorized = Unauthorized
+
+  NotProvided = Class.new(Error)
+  Error::NotProvided = NotProvided
 end

data/lib/social_media/service/base.rb

@@ -6,15 +6,24 @@ module SocialMedia
       end
 
       attr_reader :connection_params
+      attr_reader :not_provided_behavior
 
       def initialize connection_params
         @connection_params = connection_params
+        @not_provided_behavior = connection_params.delete(:not_provided_behavior) || :raise_error
       end
 
       def cast_error error
         return Error
       end
-      
+
+      def raise_not_provided_error
+        return if not_provided_behavior == :silent
+
+        method_name = caller.first.scan(/\:in \`(.*)\'$/).join
+        raise SocialMedia::Error::NotProvided.new "#{self.class.to_s}##{method_name}"
+      end
+
       def handle_error &block
         begin
           yield

data/lib/social_media/service/twitter.rb

@@ -20,7 +20,7 @@ module SocialMedia::Service
     end
 
     def send_message message, options={}
-      return send_text_message(message, options) unless options.has_key? :filenames
+      return send_text_message(message, options) unless options.has_key?(:filenames) || options.has_key?(:filename)
       send_multipart_message message, options
     end
 
@@ -29,17 +29,44 @@ module SocialMedia::Service
       result.first.id
     end
 
-    def update_profile_background filename
-      client.update_profile_banner(open filename)
+    def upload_profile_cover filename
+      client.update_profile_banner(open_file filename)
     end
 
-    def update_profile_image filename
-      result = client.update_profile_image(open filename)
+    def remove_profile_cover
+      client.remove_profile_banner
+    end
+
+    def upload_profile_avatar filename
+      result = client.update_profile_image(open_file filename)
       result.id
     end
 
+    def remove_profile_avatar
+      raise_not_provided_error
+    end
+
     private
 
+    # The Twitter gem is particular about the type of IO object it
+    #   recieves when tweeting an image. If an image is < 10kb, Ruby opens it as a
+    #   StringIO object. Which is not supported by the Twitter gem/api.
+    #
+    #   This method ensures we always have a valid IO object for Twitter.
+    def open_file filename
+      image_file = open(filename)
+      return image_file unless image_file.is_a?(StringIO)
+
+      base_name = File.basename(filename)
+      temp_file = Tempfile.new(base_name)
+
+      temp_file.binmode
+      temp_file.write(image_file.read)
+      temp_file.close
+
+      open(temp_file.path)
+    end
+
     def send_text_message message, options
       handle_error do
         result = client.update(message, options)
@@ -48,11 +75,9 @@ module SocialMedia::Service
     end
 
     def send_multipart_message message, options
-      media = Array(options.delete(:filenames)).map{ |fn| File.new(fn) }
-      handle_error do
-        result = client.update_with_media(message, media, options)
-        result.id
-      end
+      media_ids = Array(options.delete(:filename)).map{ |fn| client.upload open_file(fn) }
+      media_ids += Array(options.delete(:filenames)).map{ |fn| client.upload open_file(fn) }
+      send_text_message message, options.merge(media_ids: media_ids.join(","))
     end
   end
 end

data/lib/social_media/version.rb

@@ -1,3 +1,3 @@
 module SocialMedia
-  VERSION = '0.0.1'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: social_media
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - mwlang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-08 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: twitter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.1
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
-  name: twitter
+  name: koala
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: koala
+  name: google-api-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: google-api-client
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
+        version: 10.5.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 10.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement