aloha_analyzer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8ba9337afa5ffabd013152135eb491570b1e8b4
+  data.tar.gz: c28c69157e0fae6b1337cb05a00d0d9f056e1004
+SHA512:
+  metadata.gz: 149cc56d51da2fdee363fa8ea10ac274cf62d65cc9850cadbcaf9c6e868ad278fc438755bd70b256746ac8cbeb086ad73789c9ced24d6b140f340cb8fbba3e50
+  data.tar.gz: 7b15090925e99953fd7c0262efd3c2dba2708f8527cb8d54af29fd74081c15b4b4f5080d1e73bf4576a464e2ebe644b4a520c9411ba08c4f440fff7ec8b9fb68

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthieu Aussaguel
+
+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,32 @@
+# Aloha Analyzer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aloha_analyzer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aloha_analyzer
+
+## Usage
+
+```ruby
+aloha = AlohaAnalyser::Follower.new(username, { credentials: credentials })
+alohas.calculate!
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/aloha_analyzer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aloha_analyzer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aloha_analyzer"
+  spec.version       = AlohaAnalyzer::VERSION
+  spec.authors       = ["Matthieu Aussaguel"]
+  spec.email         = ["matthieu.aussaguel@gmail.com"]
+  spec.description   = %q{Analyze twitter followers languages}
+  spec.summary       = %q{Analyze twitter followers languages}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'webmock', '~> 1.17'
+  spec.add_dependency 'twitter', '~> 5.6'
+end

data/lib/aloha_analyzer/follower.rb

@@ -0,0 +1,51 @@
+module AlohaAnalyzer
+  class Follower
+    attr_reader :screen_name, :cursor, :languages
+
+    def initialize(screen_name, options = {})
+      @screen_name = screen_name
+      @cursor      = options[:cursor] || -1
+      @languages   = options[:languages] || Hash.new(0)
+      @credentials = options[:credentials]
+    end
+
+    def count
+      counter = 0
+      @languages.each do |_, language_count|
+        counter += language_count
+      end
+      counter
+    end
+
+    def calculate!
+      response = client.followers(@screen_name, request_options).to_h
+      response[:users].each do |follower|
+        increment follower[:lang]
+      end
+      @cursor = response[:next_cursor]
+    end
+
+    private
+
+    def request_options
+      {
+        count:       200,
+        skip_status: false,
+        cursor:      @cursor
+      }
+    end
+
+    def client
+      @client ||= ::Twitter::REST::Client.new(
+        consumer_key:         @credentials[:consumer_key],
+        consumer_secret:      @credentials[:consumer_secret],
+        access_token:         @credentials[:access_token],
+        access_token_secret:  @credentials[:access_token_secret]
+        )
+    end
+
+    def increment(language)
+      @languages[language] += 1
+    end
+  end
+end

data/lib/aloha_analyzer/version.rb

@@ -0,0 +1,3 @@
+module AlohaAnalyzer
+  VERSION = "0.0.1"
+end

data/lib/aloha_analyzer.rb

@@ -0,0 +1,5 @@
+require "aloha_analyzer/version"
+require "aloha_analyzer/follower"
+
+module AlohaAnalyzer
+end

data/spec/aloha_analyzer/follower_spec.rb

@@ -0,0 +1,197 @@
+require 'spec_helper'
+
+describe AlohaAnalyzer::Follower do
+  subject(:follower) { described_class.new(screen_name, options) }
+  let(:screen_name)     { 'mattaussaguel'  }
+
+  let(:options) do
+    {
+      credentials: credentials
+    }
+  end
+
+  let(:credentials) do
+    {
+      consumer_key:        'CK',
+      consumer_secret:     'CS',
+      access_token:        'AT',
+      access_token_secret: 'AS'
+    }
+  end
+
+  describe '#new' do
+    it 'sets the screen_name' do
+      subject.screen_name.should eq screen_name
+    end
+
+    context 'cursor option is passed' do
+      let(:options) { { cursor: cursor } }
+      let(:cursor)  { double }
+
+      it 'sets the cursor to the option value' do
+        subject.cursor.should eq cursor
+      end
+    end
+
+    context 'cursor option is not set' do
+      it 'sets the cursor to -1' do
+        subject.cursor.should eq -1
+      end
+    end
+
+    context 'when languages option are passed' do
+      let(:languages) { double }
+      let(:options) { { languages: languages } }
+
+      it 'sets the languages to the option value' do
+        subject.languages.should eq languages
+      end
+    end
+
+    context 'when languages option is not set' do
+      it 'sets the cursor to an empty hash' do
+        subject.languages.should be_a Hash
+        subject.languages.should be_empty
+      end
+    end
+  end
+
+  describe '#count' do
+    let(:options) { { languages: languages } }
+    let(:languages) do
+      {
+        'en' => 2,
+        'fr' => 3,
+        'es' => 0
+      }
+    end
+
+    it 'includes the total language count' do
+      subject.count.should eq 5
+    end
+  end
+
+  describe '#calculate!' do
+    let(:followers) do
+      {
+        "users" => [
+          {"id" => 1, "lang" => "en"},
+          {"id" => 2, "lang" => "fr"},
+          {"id" => 3, "lang" => "en"},
+          {"id" => 4, "lang" => "de"}
+        ],
+        "next_cursor" => next_cursor
+      }
+    end
+    let(:next_cursor) { 1 }
+    let(:query_args) do
+      {
+        skip_status: false,
+        count: 200,
+        :cursor      => '-1',
+        :screen_name => screen_name}
+    end
+
+    let(:body)    { followers.to_json }
+    let(:headers) { {:content_type => 'application/json; charset=utf-8'} }
+
+    before do
+      stub_get('/1.1/followers/list.json')
+        .with(:query => query_args)
+        .to_return(:body => body, :headers => headers)
+    end
+
+    context 'when first call' do
+      it 'sets the next cursor' do
+        subject.calculate!
+
+        subject.cursor.should eq next_cursor
+      end
+
+      it 'calculates the langauges stats' do
+        subject.calculate!
+
+        subject.languages.should eq(
+          'en' => 2,
+          'fr' => 1,
+          'de' => 1
+        )
+      end
+
+      it 'updates the count value' do
+        subject.calculate!
+
+        subject.count.should eq 4
+      end
+
+      it 'creates a new twitter client' do
+        Twitter::REST::Client.should_receive(:new).and_call_original
+
+        subject.calculate!
+      end
+    end
+
+    context 'when run the second time' do
+      let(:new_query_args) do
+        {
+          skip_status: false,
+          count: 200,
+          :cursor      => '1',
+          :screen_name => screen_name}
+      end
+
+      let(:new_followers) do
+        {
+          "users" => [
+            {"id" => 1, "lang" => "fr"},
+            {"id" => 2, "lang" => "de"},
+            {"id" => 3, "lang" => "es"},
+            {"id" => 4, "lang" => "de"}
+          ],
+          "next_cursor" => new_next_cursor
+        }
+      end
+
+      let(:new_next_cursor) { 1 }
+      let(:new_body) { new_followers.to_json }
+
+      before do
+        subject.calculate!
+
+        stub_get('/1.1/followers/list.json')
+          .with(query: new_query_args)
+          .to_return(body: new_body, headers: headers)
+
+      end
+
+      it 'sets the next cursor' do
+        subject.calculate!
+
+        subject.cursor.should eq new_next_cursor
+      end
+
+      it 'calculates the langauges stats' do
+        subject.calculate!
+
+        subject.languages.should eq(
+          'en' => 2,
+          'fr' => 2,
+          'de' => 3,
+          'es' => 1
+        )
+      end
+
+      it 'updates the count value' do
+        subject.calculate!
+
+        subject.count.should eq 8
+      end
+
+      it 'does not create another twitter client' do
+        Twitter::REST::Client.should_not_receive(:new)
+
+        subject.calculate!
+      end
+    end
+  end
+end

data/spec/aloha_analyzer_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe AlohaAnalyzer do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'debugger'
+require 'bundler/setup'
+
+require 'twitter'
+require 'aloha_analyzer'
+require 'webmock/rspec'
+
+
+RSpec.configure do |config|
+end
+
+# stolen from the twitter gem
+def stub_get(path)
+  stub_request(:get, Twitter::REST::Client::ENDPOINT + path)
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: aloha_analyzer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthieu Aussaguel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+description: Analyze twitter followers languages
+email:
+- matthieu.aussaguel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aloha_analyzer.gemspec
+- lib/aloha_analyzer.rb
+- lib/aloha_analyzer/analyzer.rb
+- lib/aloha_analyzer/follower.rb
+- lib/aloha_analyzer/version.rb
+- spec/aloha_analyzer/follower_spec.rb
+- spec/aloha_analyzer_spec.rb
+- spec/spec_helper.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.0
+signing_key: 
+specification_version: 4
+summary: Analyze twitter followers languages
+test_files:
+- spec/aloha_analyzer/follower_spec.rb
+- spec/aloha_analyzer_spec.rb
+- spec/spec_helper.rb