metwit 0.0.1 → 0.0.2

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/Gemfile

@@ -2,3 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in metwit.gemspec
 gemspec
+
+group :development, :test do
+  gem 'rspec'
+  gem 'webmock'
+  gem 'yard'
+  gem 'redcarpet'
+end
+

data/README.md

@@ -18,7 +18,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# First require the gem
+require 'metwit'
+
+# Set your api key
+Metwit.api_key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+
+## How to post a Metag
+# If you don't authenticate a user you may not be able to post metags
+Metwit.authenticate("username", "password")
+# You need a rgeo factory to project the point coordinates
+factory = RGeo::Cartesian.factory
+# Then you can create a basic metag
+metag = Metwit::Metag.new(
+      :weather => {:status => :clear},
+      :position => factory.point(45.4, 9.1)
+)
+# Then post it to the server
+metag.create!
+
+## How to get a user by id
+user = Metwit::User.find('id')
+
+## How to get a metag by id
+metag = Metwit::Metag.find('id')
+
+## How to get metags in a geographical region
+metags = Metwit::Metag.in_rect(45.4, 9.1, 45.3, 9.0)
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,9 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/metwit.rb

@@ -1,5 +1,10 @@
+require "metwit/auth"
+require "metwit/constants"
 require "metwit/version"
+require "metwit/metag"
+require "metwit/user"
 
+
+# All classes are qualified in the namespace Metwit
 module Metwit
-  # Your code goes here...
 end

data/lib/metwit/auth.rb

@@ -0,0 +1,32 @@
+module Metwit
+  class << self
+    
+    # The developer api key
+    attr_accessor :api_key
+
+    # The user access token
+    attr_accessor :access_token
+
+    # Tell if login was successuful
+    # @return [Boolean]
+    def logged?
+      @logged ||= false
+    end
+
+    # Exchange the developer api key for a user access token
+    def authenticate(username, password)
+      @logged = false
+      url = BASE_URL + '/auth/'
+
+      response = HTTParty.post(url, :body => {:username=>username, :password=>password}, :headers => {'Authorization' => "Bearer #{@api_key}"})
+      @access_token = response['bearer_token']
+      @logged = true if response.code == 200
+      response
+    end
+
+    def bearer_token
+      self.logged? ? @access_token : @api_key
+    end
+        
+  end
+end

data/lib/metwit/constants.rb

@@ -0,0 +1,3 @@
+module Metwit
+  BASE_URL = "https://api.metwit.me/v2"
+end

data/lib/metwit/metag.rb

@@ -0,0 +1,154 @@
+require 'rgeo'
+require 'rgeo-geojson'
+require 'httparty'
+require 'json'
+
+module Metwit
+
+  # Metags are the weather tags
+  class Metag
+    include HTTParty
+    base_uri(BASE_URL+'/metags')
+    headers 'Authorization' => "Bearer #{Metwit.bearer_token}"
+
+    # Mandatory and guaranteed.  
+    # Weather is an Hash with two keys: :status and :details  
+    # Valid :status values are:  
+    # :clear, :rainy, :stormy, :snowy, :partly\_cloudy, :cloudy, :hailing, :heavy\_seas, :calm\_seas, :foggy, :snow\_flurries, :windy, :partly\_cloudy, :uknown
+    # @return [{Symbol => String, Hash}] weather data
+    attr_accessor :weather
+
+    # Guaranteed.
+    # The metag id
+    # @return [String] unique identifier of the metag
+    attr_reader :id
+
+    # Guaranteed.
+    # The metag timestamp.
+    # @return [Time] when the metag was created
+    attr_reader :timestamp
+
+    # Mandatory and guaranteed.
+    # The geo location of the metag with GeoJSON format
+    # @return [RGeo::Feature::Point] geo location of the metag
+    attr_accessor :position
+
+    # Guaranteed.
+    # The issuer of the metag.
+    # @return [User] the issuer of the metag
+    attr_accessor :user
+
+    # Guaranteed.
+    # The number of replies
+    # @return [Fixnum] the number of replies
+    attr_accessor :replies_count
+
+    # Guaranteed
+    # The number of thanks
+    # @return [Fixnum] the number of thanks
+    attr_accessor :thanks_count
+    
+      
+    def initialize(args={})
+      @id = args[:id]
+      @weather = args[:weather]
+      @position = args[:position]
+      @timestamp = args[:timestamp]
+      @weather = args[:weather]
+      @user = args[:user]
+      @replies_count = args[:replies_count]
+      @thanks_count = args[:thanks_count]
+    end
+
+    # This method validates the metag for the submission
+    # @return [Boolean]
+    def valid?
+      return false unless weather_valid?
+      return false unless position_valid?
+      true
+    end
+
+    # This method check if the weathear is valid
+    # @return [Boolean]
+    def weather_valid?
+      return false if @weather.nil?
+      return false if @weather[:status].nil?
+      return false unless weather_statuses.include?(@weather[:status])
+      true
+    end
+
+    # This method check if the position is valid
+    # @return [Boolean]
+    def position_valid?
+      return false if @position.nil?
+      return false unless RGeo::Feature::Point.check_type(@position)
+      true
+    end
+    
+    
+    # This method return all the reognized weather statuses
+    # @return [Array<Symbol>]
+    def weather_statuses
+      [:clear, :rainy, :stormy, :snowy, :partly_cloudy, :cloudy, :hailing, :heavy_seas, :calm_seas, :foggy, :snow_flurries, :windy, :partly_cloudy]
+    end
+
+    # This method encode metag in json for submission
+    # @return [String]
+    def to_json
+      raise "metag in invalid" unless valid?
+      
+      {
+        weather: {
+          status: self.weather[:status].to_s.gsub(/_/,' '),
+        },
+        geo: RGeo::GeoJSON.encode(self.position),
+      }.to_json
+    end
+
+    # This metod POST a metag
+    def create!
+      raise "invalid metag" unless self.valid?
+      response = self.class.post('/', :body => self.to_json, :headers => {'Cookie' => Metwit.cookie, 'Content-Type' => 'application/json' })
+      raise "post failed" unless response.code == 201
+      response
+    end
+        
+    class << self
+      # Return the metag associated with the id
+      # @return [Metag]
+      def find(id)
+        response = get("/#{id}/")
+        raise "http error" unless response.code == 200
+        self.from_json(response)
+      end
+
+      # Return metags in a geographical region
+      # return [Array<Metag>]
+      def in_rect(lat_n, lng_w, lat_s, lng_e)
+        response = get('/', :query => {:rect => "#{lat_n},#{lng_w},#{lat_s},#{lng_e}"})
+        metags = []
+        response['objects'].each do |metag_json|
+          metags << self.from_json(metag_json)
+        end
+        metags
+      end
+      
+      # Return a metag form a JSON response
+      # @return [User]
+      def from_json(response)
+        args = {
+          id: response['id'],
+          timestamp: Time.parse(response['timestamp']),
+          weather: {status: response['weather']['status'].gsub(/ /, '_').to_sym},
+          position: RGeo::GeoJSON.decode(response['geo']),
+          user: User.from_json(response['user']),
+          replies_count: response['replies_count'],
+          thanks_count: response['thanks_count'],
+        }
+        Metag.new(args)
+      end
+      
+    end
+    
+  end
+end

data/lib/metwit/user.rb

@@ -0,0 +1,122 @@
+require 'httparty'
+
+module Metwit
+
+  # A user of Metwit
+  class User
+    include HTTParty
+    base_uri(BASE_URL+'/users')
+    headers 'Authorization' => "Bearer #{Metwit.bearer_token}"
+    
+    # Guaranteed.
+    # The user id
+    # @return [String] unique identifier of the user
+    attr_reader :id
+
+    # Guaranteed.
+    # The user nickname
+    # @return [String] nickname
+    attr_accessor :nickname
+
+    # Guaranteed.
+    # Total number of metags sent by the user
+    # @return [Fixnum] total number of metags
+    attr_reader :metags_count
+
+    # Guaranteed.
+    # Number of metags sent today by the user
+    # @return [Fixnum] today metags number
+    attr_reader :today_metags_count
+
+    # Guaranteed.
+    # Avatar url
+    # @return [URI] avatar url
+    attr_accessor :avatar
+
+    # Guaranteed.
+    # Tells if you follow the user
+    # @return [Boolean]
+    def followed?
+      @is_followed
+    end
+
+    # Guaranteed.
+    # Followers count
+    # @return [Fixnum] The number of followers
+    attr_reader :followers_count
+
+    # Guaranteed.
+    # Following count
+    # @return [Fixnum] The number of following users
+    attr_reader :following_count
+
+    # Sport activities
+    # @return [Array<Symbol>] Sport activities array
+    attr_accessor :activities
+
+    # The badges the user earned
+    # @return [Array<Symbol>] Bagdges
+    attr_accessor :badges
+
+    # Guaranteed.
+    # Tells if the user is connected with facebook
+    # @return [Boolean]
+    def facebook?
+      @has_facebook
+    end
+
+    # Guaranteed.
+    # Tells if the user is connected with twitter
+    def twitter?
+      @has_twitter
+    end
+
+    # Personal
+    # The user email
+    # @return [String]
+    attr_accessor :email
+
+    def initialize(args={})
+      @id = args[:id]
+      @nickname = args[:nickname]
+      @metags_count = args[:metags_count]
+      @today_metags_count = args[:today_metags_count]
+      @avatar = args[:avatar]
+      @is_followed = args[:followed]
+      @followers_count = args[:followers_count]
+      @following_count = args[:following_count]
+      @has_facebook = args[:has_facebook]
+      @has_twitter = args[:has_twitter]
+    end
+    
+    class << self
+      # Return the user associated with the id
+      # @return [User]
+      def find(id)
+        response = get("/#{id}/")
+        raise "http error" unless response.code == 200
+        self.from_json(response)
+      end
+
+      # Create a user from an HTTParty::Response
+      # @return [User]
+      def from_json(response)
+        args = {
+          id: response['id'],
+          nickname: response['nickname'],
+          metags_count: response['reports_count'],
+          today_metags_count: response['todays_reports_count'],
+          avatar: URI.parse(response['avatar_url']),
+          followed: response['is_followed'],
+          followers_count: response['followers_count'],
+          following_count: response['following_count'],
+          has_facebook: response['has_facebook'],
+          has_twitter: response['has_twitter'],
+        }
+        User.new(args)
+      end
+            
+    end
+      
+  end
+end

data/lib/metwit/version.rb

@@ -1,3 +1,4 @@
 module Metwit
-  VERSION = "0.0.1"
+  # The version of the metwit gem
+  VERSION = "0.0.2"
 end

data/metwit.gemspec

@@ -14,4 +14,6 @@ Gem::Specification.new do |gem|
   gem.name          = "metwit"
   gem.require_paths = ["lib"]
   gem.version       = Metwit::VERSION
+  gem.add_dependency('httparty')
+  gem.add_dependency('rgeo-geojson')
 end

data/spec/fixtures/metag1234

@@ -0,0 +1,9 @@
+HTTP/1.0 200 OK
+Date: Thu, 19 Jul 2012 20:00:13 GMT
+Server: WSGIServer/0.1 Python/2.7.1
+Vary: Accept-Language, Cookie
+Content-Type: application/json; charset=utf-8
+Content-Language: en-us
+Set-Cookie:  sessionid=223bcf639c1bf9a552a4745fdc8f1c2f; expires=Sun, 17-Jul-2022 20:00:13 GMT; Max-Age=315360000; Path=/
+
+{"country": "United States", "geo": {"coordinates": [-122.40641784667969, 37.78583526611328], "type": "Point"}, "icon": "http://api.metwit.me/v2/icons/sunny", "id": "1234", "locality": "San Francisco", "replies_count": 0, "resource_uri": "/v2/metags/1/", "thanks_count": 0, "timestamp": "2012-07-13T15:53:34.250591", "user": {"activities": [], "avatar_url": "https://s3-eu-west-1.amazonaws.com/nuvola-static-eu/avatar/avatar.jpeg", "favorite_weather": "sunny", "followers_count": 0, "following_count": 0, "gender": "N", "has_facebook": false, "has_twitter": false, "id": "6576", "nickname": "davider", "reports_count": 0, "resource_uri": "/v2/users/6576/", "todays_reports_count": 3, "username": "davider", "is_followed": false}, "weather": {"status": "clear"}, "weight": -525998.758139}

data/spec/fixtures/user6576

@@ -0,0 +1,9 @@
+HTTP/1.0 200 OK
+Date: Wed, 18 Jul 2012 20:18:03 GMT
+Server: WSGIServer/0.1 Python/2.7.1
+Vary: Accept-Language, Cookie
+Content-Type: application/json; charset=utf-8
+Content-Language: en-us
+Set-Cookie:  sessionid=acd2192c9f992cf424520af41bacab1b; expires=Sat, 16-Jul-2022 20:18:03 GMT; Max-Age=315360000; Path=/
+
+{"activities": [], "avatar_url": "https://s3-eu-west-1.amazonaws.com/nuvola-static-eu/avatar/avatar.jpeg", "favorite_weather": "sunny", "followers_count": 0, "following_count": 0, "gender": "N", "has_facebook": false, "has_twitter": false, "id": "6576", "nickname": "davider", "reports_count": 0, "resource_uri": "/v2/users/6576/", "todays_reports_count": 3, "username": "davider", "is_followed": false}

data/spec/metwit/metag_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+module Metwit
+  describe Metag do
+    def metag
+      factory = RGeo::Cartesian.factory
+      
+      options = {
+        :weather => {:status => :clear},
+        :position => factory.point(1,2),
+      }
+      @metag ||= Metag.new(options)
+    end
+
+    describe "#weather_valid?" do
+      it "should return false when weather is nil" do
+        metag.weather = nil
+        metag.weather_valid?.should_not be_true
+      end
+
+      it "should return false when weather[:status] is nil" do
+        metag.weather[:status] = nil
+        metag.weather_valid?.should_not be_true
+      end
+
+      it "should return false with an unrecogonized weather status" do
+        metag.weather[:status] = :vola_tutto
+        metag.weather_valid?.should_not be_true
+      end
+
+      it "should return true with a recognized weather status" do
+        metag.weather_valid?.should be_true
+      end
+
+      it "should return false when weather[:status] is not a symbol" do
+        metag.weather[:status] = 'sunny'
+        metag.weather_valid?.should_not be_true
+      end
+      
+      
+    end
+
+    describe "#position_valid?" do
+      it "should return false when position is nil" do
+        metag.position = nil
+        metag.position_valid?.should_not be_true
+      end
+
+      it "should return false when position is not a geographical point" do
+        gis = RGeo::Cartesian.factory
+        metag.position = gis.line(gis.point(1,2), gis.point(2,1))
+        metag.position_valid?.should_not be_true
+      end
+
+      it "should return true when position is a Point" do
+        metag.position_valid?.should be_true
+      end
+      
+
+    end
+
+    describe "#valid?" do
+      it "should return true with a valid metag" do
+        metag.should be_valid
+      end
+
+      it "should return false with an invalid metag" do
+        metag.position = nil
+        metag.should_not be_valid
+      end
+
+    end
+    
+
+    describe "::find" do
+      around do |example|
+        WebMock.disable_net_connect!
+        url = BASE_URL + '/metags/1234/'
+        WebMock.stub_http_request(:get, url).to_return(fixture("metag1234"))
+        example.run
+        WebMock.reset!
+        WebMock.allow_net_connect!
+      end
+
+      it "should return a Metag object" do
+        Metag.find("1234").should be_a Metag
+      end
+
+      it "should return a Metag with the id requested" do
+        id = "1234"
+        metag = Metag.find(id)
+        metag.id.should eq id
+      end
+
+      it "should have all the guaranteed fields" do
+        metag = Metag.find("1234")
+        metag.id.should_not be_nil
+        metag.timestamp.should_not be_nil
+        metag.weather.should_not be_nil
+        metag.position.should_not be_nil
+        metag.user.should_not be_nil
+        metag.replies_count.should_not be_nil
+        metag.thanks_count.should_not be_nil
+      end
+
+    end
+
+    describe "#to_json" do
+      it "should encode GeoJSON correctly" do
+        json_metag = JSON.parse(metag.to_json)
+        new_metag = Metag.new(:position => RGeo::GeoJSON.decode(json_metag['geo']))
+        new_metag.position_valid?.should be_true
+      end
+
+      it "should encode weather status correctly" do
+        json_metag = JSON.parse(metag.to_json)
+        new_metag = Metag.new(:weather => {:status => json_metag['weather']['status'].gsub(/ /, '_').to_sym})
+        new_metag.weather_valid?.should be_true
+      end
+      
+    end
+
+    describe "#create!" do
+    end
+
+    describe "::in_rect" do
+    end
+    
+    describe "::from_json" do
+      around do |example|
+        WebMock.disable_net_connect!
+        url = BASE_URL + '/metags/1234/'
+        WebMock.stub_http_request(:get, url).to_return(fixture("metag1234"))
+        example.run
+        WebMock.reset!
+        WebMock.allow_net_connect!
+      end
+
+      def metag
+        url = BASE_URL + '/metags/1234/'
+        response = HTTParty.get(url)
+        Metag.from_json(response)
+      end
+
+      it "should return a metag with String id" do
+        metag.id.should be_a String
+      end
+
+      it "should return a metag with Time timestamp" do
+        metag.timestamp.should be_a Time
+      end
+
+      it "should return a metag with RGeo::Feature::Point position" do
+        metag.position_valid?.should be_true
+      end
+      
+      it "should return a metag with valid weather" do
+        metag.weather_valid?.should be_true
+      end
+
+      it "should return a metag with User user" do
+        metag.user.should be_a User
+      end
+
+      it "should return a metag with Fixnum replies_count" do
+        metag.replies_count.should be_a Fixnum
+      end
+
+      it "should return a metag with Fixnum thanks_count" do
+        metag.thanks_count.should be_a Fixnum
+      end
+
+    end
+  end
+end

data/spec/metwit/user_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+module Metwit
+  describe User do
+
+    describe "::find" do
+
+      around do |example|
+        WebMock.disable_net_connect!
+        url = BASE_URL + '/users/6576/'
+        WebMock.stub_http_request(:get, url).to_return(fixture("user6576"))
+        example.run
+        WebMock.reset!
+        WebMock.allow_net_connect!
+      end
+      
+      it "should return a User object" do
+        User.find("6576").should be_a User
+      end
+
+      it "should return a User with the id requested" do
+        id = "6576"
+        user = User.find(id)
+        user.id.should eq id
+      end
+      
+      it "should have all the guaranteed fields" do
+        user = User.find("6576")
+        user.id.should_not be_nil
+        user.nickname.should_not be_nil
+        user.metags_count.should_not be_nil
+        user.today_metags_count.should_not be_nil
+        user.avatar.should_not be_nil
+        user.followed?.should_not
+        user.followers_count.should_not be_nil
+        user.following_count.should_not be_nil
+        user.facebook?.should_not be_nil
+        user.twitter?.should_not be_nil
+      end
+      
+    end
+
+    describe "::from_json" do
+      around do |example|
+        WebMock.disable_net_connect!
+        url = BASE_URL + '/users/6576/'
+        WebMock.stub_http_request(:get, url).to_return(fixture("user6576"))
+        example.run
+        WebMock.reset!
+        WebMock.allow_net_connect!
+      end
+
+      def user
+        url = BASE_URL + '/users/6576/'
+        response = HTTParty.get(url)
+        User.from_json(response)
+      end
+
+      it "should return a user with String id" do
+        user.id.should be_a String
+      end
+
+      it "should return a user with String nickname" do
+        user.nickname.should be_a String
+      end
+
+      it "should return a user with Fixnum metags_count" do
+        user.metags_count.should be_a Fixnum
+      end
+
+      it "should return a user with Fixnum today_metags_count" do
+        user.today_metags_count.should be_a Fixnum
+      end
+
+      it "should return a user with URI avatar" do
+        user.avatar.should be_a URI
+      end
+
+      it "should return a user with Boolean followed" do
+        user.followed?.should be_boolean
+      end
+
+      it "should return a user with Fixnum followers_count" do
+        user.followers_count.should be_a Fixnum
+      end
+
+
+      it "should return a user with Fixnum following_count" do
+        user.following_count.should be_a Fixnum
+      end
+
+      it "should return a user with Boolean facebook" do
+        user.facebook?.should be_boolean
+      end
+
+      it "should return a user with Boolean twitter" do
+        user.twitter?.should be_boolean
+      end
+            
+    end
+    
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'metwit'
+require 'webmock/rspec'
+
+RSpec::Matchers.define :be_boolean do
+  match do |value|
+    value.is_a?(TrueClass) or value.is_a?(FalseClass)
+  end
+end
+
+
+WebMock.allow_net_connect!
+
+def fixture(filename)
+  open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename.to_s}"))
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metwit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-15 00:00:00.000000000 Z
-dependencies: []
+date: 2012-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rgeo-geojson
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby SDK for Metwit public APIs
 email:
 - sim@me.com
@@ -19,13 +51,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/metwit.rb
+- lib/metwit/auth.rb
+- lib/metwit/constants.rb
+- lib/metwit/metag.rb
+- lib/metwit/user.rb
 - lib/metwit/version.rb
 - metwit.gemspec
+- spec/fixtures/metag1234
+- spec/fixtures/user6576
+- spec/metwit/metag_spec.rb
+- spec/metwit/user_spec.rb
+- spec/spec_helper.rb
 homepage: http://metwit.com
 licenses: []
 post_install_message: 
@@ -50,5 +92,10 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby SDK for Metwit public APIs
-test_files: []
+test_files:
+- spec/fixtures/metag1234
+- spec/fixtures/user6576
+- spec/metwit/metag_spec.rb
+- spec/metwit/user_spec.rb
+- spec/spec_helper.rb
 has_rdoc: