CSApi 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37402553ba84503cfbe5ee0b2548551865a9b765
-  data.tar.gz: 285cad08bf766155b0acefd66bdb3110a5b0e562
+  metadata.gz: 155eb0a39f7dbf9a5c75756e9f50ee73b0d1b42c
+  data.tar.gz: a3c35ded375372df4e48d1852dafbfca56b6e0e0
 SHA512:
-  metadata.gz: 28a155a0b139bd9536ce28251928e04d059bea187e34e0a88bfc1a1c776b370e49b8b32b3020ef18dad4454a2040e250686a708796bac92ed5401160f52b72dc
-  data.tar.gz: 6402789e62c0237709a7512a25c9d43bb642f7de80b415ad849f84dcad136c8eab5bb63bc16181eed7237058c73c4c62c43d4dd395061b8750e6f24323e4f325
+  metadata.gz: 83a322ecb1cc8cca2d497a530ceb95e2f1c6048eb22d2a278b9cce089c711562890da1953f19eef3874c26083c1eb8dceae4d9e675bfd33c09806276c4b7cfe2
+  data.tar.gz: 5ab3947319ac8b2ac0b5adc4568a4101bcf905a82a43e845685d1c65714406b87491ab36e9349555da8d0f96e2e3378cc77abd162dd272a2e9e434a270b036be

data/CONTRIBUTORS

@@ -0,0 +1,2 @@
+Peter Nosko - Search
+Davit-gh - Messages

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in csapi.gemspec
 gemspec
+
+gem 'nokogiri', '~>1.6.1'
+gem 'httparty', '~>0.13.1'
+gem 'json', '~>1.8.1'

data/examples/example.rb

@@ -1,11 +1,14 @@
 #!/usr/bin/env ruby
 #encoding: utf-8
 
-require './lib/CSApi.rb'
+require_relative '../lib/CSApi.rb'
 require 'pp'
 
+user = ENV['USER'] || 'user'
+password = ENV['PASSWORD'] || 'password'
+
 begin
-  api = CS::Api.new('username','password')
+  api = CS::Api.new(user,password)
 rescue CS::AuthError
   puts "Incorrect username or password"
   exit
@@ -16,7 +19,6 @@ end
 # ===
 profile = api.profile('205974')
 
-
 ## ===
 ## Get a user's photos, by default ours
 ## ===
@@ -41,17 +43,17 @@ requests = api.requests(limit)
 # ===
 # Get the current user's inbox messages
 # ===
-m = api.messages('inbox', 1)
-pp m.count
+messages = api.messages('inbox', 1)
 
-m.each do |m|
-  pp m
+messages.each do |m|
+  puts m.to_h
 end
 
-if m.has_more?
-  pp m.more.count
+
+if messages.has_more?
+  p messages.more.count
 else
-  pp "end of messages"
+  p "end of messages"
 end
 
 
@@ -61,25 +63,25 @@ end
 details = {
   subject: 'This is my request subject',
   number: 1, #How many people travel with you
-  arrival: 1339543920, #a Unix Timestamp with your arrival date
-  departure: 1339643920, #a Unix Timestamp with your departure date
+  arrival: Time.at(1339543920), #a Time instance
+  departure: Time.at(1339643920), #a Time instance
   arrival_flexible: true,
   departure_flexible: false,
   is_open_couchrequest: false,
   to: 12345, #a numeric user id, I guess, have yet to figure this out ,
   message: 'This is my request message' #I've yet to figure out how to do the multi-part requests
 }
-couch_request = CS::Request.new(details)
+#couch_request = CS::Request.new(details)
 
 api.requests(1).each do |key, value|
   pp value
 end
-#
+
 ## ===
 ##   Search for people in a city with various search constraints
 ## ===
 options = {
-  location: 'venice',
+  location: 'mexico city',
   gender: 'female',
   :'has-photo' => false,
   :'member-type' => 'host' ,
@@ -89,7 +91,11 @@ options = {
   :'min-age' => nil,
   :'max-age' => nil,
 }
-results = api.search(options)
+search = CS::CouchSearch.new(options)
+results = search.execute
+
 results.each do |id, user|
   puts "Found (UID:#{id}) #{user[:name]} in #{user[:location]} with a couch status of #{user[:status]} and a photo #{user[:pic]}\n\n"
 end
+
+puts results.more.count

data/lib/csapi.rb

@@ -10,18 +10,41 @@ Copyright (c) 2012 Partido Surrealista Mexicano
 require 'httparty'
 require 'json'
 require 'nokogiri'
+
+require_relative 'csapi/version.rb'
+require_relative 'csapi/errors.rb'
+require_relative 'csapi/messages.rb'
+require_relative 'csapi/request.rb'
+require_relative 'csapi/search.rb'
+
 module CS
-    
-  class Api
+  
+  @@instance = nil
+
+  def self.instance
+    @@instance
+  end
+
+  def self.instance= instance
+    @@instance = instance
+  end
+
+  class HTTP
     include HTTParty
     base_uri 'https://api.couchsurfing.org'
     headers "Content-Type" => 'application/json'
     follow_redirects false
-    @uid = '0'
+    #debug_output $stderr
+  end
 
+  class Api
+    
+    attr_accessor :uid;
+    @uid = '0'
+    
     def initialize(username, password)
       @username = username
-      r = self.class.post('/sessions', body:{username: username, password: password}.to_json)
+      r = HTTP.post('/sessions', body:{username: username, password: password}.to_json)
       
       raise CS::AuthError.new("Could not login") if r.code != 200
       
@@ -33,20 +56,17 @@ module CS
       @uid = data['url'].gsub(/[^\d]/, '')
       @profile = data.keep_if {|k,v| ['realname', 'username', 'profile_image', 'gender', 'address'].include?(k)}
       @profile['uid'] = @uid
-      self.class.headers 'Cookie' => @cookies
-      @@instance = self
+      HTTP.headers 'Cookie' => @cookies
+      CS.instance = self
     end
 
-    def CS::instance
-      @@instance
-    end
 
     def requests(limit=10)
       url = "/users/#{@uid}/couchrequests"
       q = {
           limit: limit
       }
-      r = self.class.get(url, query:q)
+      r = HTTP.get(url, query:q)
       requests = {}
       response = JSON.parse r.body
       response['object'].each do |req|
@@ -59,67 +79,57 @@ module CS
 
     def request(id)
       url = "/couchrequests/#{id}"
-      r = self.class.get(url)
+      r = HTTP.get(url)
       JSON.parse r.body
     end
     
     
-    def messages(type='inbox', limit=5, start=nil)
-      
-      types = ['inbox', 'sent'];
-      throw ArgumentError.new("Can't fetch messages of kind #{type}") if !types.include? type;
-      
-      url = "/users/#{@uid}/messages"
-      q = {
-        type: type,
-        limit: limit
-      }
-      
-      if (start)
-        q[:start] = start
-      end
-      
-      r = self.class.get(url, query:q);
-      object = JSON.parse r.body
-      
-      return CS::Messages.new(object, q, self);      
+    def messages(*args)
+      CS::Messages.getMessages(*args)
     end
-		
+    
+
     def message(url)
-      r = self.class.get(url)
+      r = HTTP.get(url)
       JSON.parse r.body
     end
 
+
     def userdata
       @profile
     end
 
+
     def profile(user=@uid)
       url = "/users/#{user}/profile"
-      r = self.class.get(url)
+      r = HTTP.get(url)
       JSON.parse r.body
     end
 
+
     def photos(user=@uid)
       url = "/users/#{user}/photos"
-      r = self.class.get(url)
+      r = HTTP.get(url)
       JSON.parse r.body
     end
 
+
     def friends(user=@uid)
       url = "/users/#{user}/friends"
-      r = self.class.get(url)
+      r = HTTP.get(url)
       JSON.parse r.body
     end
 
+
     def references(user=@uid)
       url = "/users/#{user}/references"
-      r = self.class.get(url)
+      r = HTTP.get(url)
       JSON.parse r.body
     end
 
+
     def search(options)
-    
+      
       defaults = {
         location: nil,
         gender: nil,
@@ -133,113 +143,7 @@ module CS
         :platform => 'android'
       }
     
-      options = defaults.merge(options)
-      html = self.class.get('/msearch', :query => options)
-      doc = Nokogiri::HTML(html);
-      users = {}
-      statuses = {
-        'M' => 'maybe',
-        'T' => 'travelling',
-        'Y' => 'available',
-        'N' => 'unavailable'
-      }
-      doc.xpath('//article').each do |article|
-        id = article.at_css('a').attr('href').split('/').last
-        user = {
-          name: article.children.at_css("h2").content,
-          location: article.children.at_css("div.location").content,
-          status: statuses[article['class'].match(/couch-([A-Z])/)[1]],
-          pic: article.at_css('img').attr('src')
-        }
-        users[id] = user
-      end
-    
-      users;
-    end
-  end
-  
-  
-  class AuthError < StandardError
-  end
-
-  class APIError < StandardError
-  end
-
-  class Messages
-    
-    @after = nil
-    @q = {}
-    @data = []
-    
-    def initialize(object, q, ref)
       
-      @after = object['after'] if object.include? 'after';
-      @q = q;
-      @ref = ref
-      @data = object['object']
-    end
-    
-    def count
-      return @data.count
-    end
-    
-    def has_more?
-      return @after != nil
-    end
-    
-    def each
-      @data.each do |url|
-        yield @ref.message(url)
-      end
-    end
-    
-    def more
-      more = @ref.messages(@q[:type], @q[:limit], @after)
-      @data = more['object']
-      @after = more.include?('after') ?  more['after'] : nil; 
-      return self
-    end
-    
-    private
-    @ref = nil
-    
-  end
-
-
-  class Request
-    @api = nil
-
-    def initialize(options={})
-      if options[:username] && options[:password]
-        api = CS.new(options[:username], options[:password])
-        options.del(:username)
-        options.del(:password)
-      else
-        api = CS::instance
-        if api==nil
-          raise CS::APIError('You have not authenticated with the service or did not provide a :username and :password')
-        end
-      end
-
-      #pp api.userdata
-      options[:subject] = options[:subject] || "#{api.userdata['realname']} from #{api.userdata['address']['country']} sent you a new CouchRequest!"
-      options[:number] = options[:number] || 1
-      options[:arrival_flexible] = options[:arrival_flexible] || false
-      options[:departure_flexible] = options[:departure_flexible] || false
-      options[:is_open_couchrequest] = options[:is_open_couchrequest] || false
-      options[:from] = api.userdata['uid']
-      options[:to] = options[:to] || api.userdata['uid']
-      options[:arrival] = Time.at(options[:arrival]).strftime("%FT%TZ") || (Time.now()+86400).strftime("%FT%TZ")
-      options[:departure] = Time.at(options[:departure]).strftime("%FT%TZ") || (Time.now()+86400*3).strftime("%FT%TZ")
-      options[:message] = options[:message] || "I'm to lazy to write a proper couch request. HOST ME PLZ?"
-      #puts options.to_json
-
-      url = "/couchrequests"
-      api.post(url, body:options.to_json)
-
-      #pp response.code
-      #pp response.body
-
     end
   end
   

data/lib/csapi/errors.rb

@@ -0,0 +1,9 @@
+module CS
+
+	class AuthError < StandardError
+	end
+
+	class APIError < StandardError
+	end
+	
+end

data/lib/csapi/messages.rb

@@ -0,0 +1,101 @@
+module CS
+  
+  class Messages
+    include Enumerable
+
+    attr_accessor :data, :after, :q
+
+    def self.getMessages(type='inbox', limit=5, start=nil)
+      types = ['inbox', 'sent'];
+      throw ArgumentError.new("Can't fetch messages of kind #{type}") unless types.include? type;
+      
+      url = "/users/#{CS::instance.uid}/messages"
+      q = {
+        type: type,
+        limit: limit
+      }
+      
+      if (start)
+        q[:start] = start
+      end
+      
+      r = HTTP.get(url, query:q);
+      object = JSON.parse r.body
+      
+      CS::Messages.new(object, q); 
+    end
+
+    
+    def initialize(object, q)
+      @after = object['after'] if object.include? 'after';
+      @q = q;
+      @data = object['object'].map {|u| Message.new(u) }
+    end
+    
+
+    def method_missing meth, *args, &block
+      @data.send(meth.to_sym, *args, &block)
+    end
+    
+
+    def has_more?
+      return @after != nil
+    end
+
+    
+    def more limit=nil
+      Messages.getMessages(@q[:type], (limit || @q[:limit]), @after)
+    end
+    
+  end
+
+  class Message
+
+    @url = nil
+    @fetched = false
+    @data = nil
+    @vars = [:title, :message, :date, :user_is_sender, :is_unread, :user, :url, :couch_request]
+    #attr_accessor *@vars
+
+    def initialize(url)
+      @url = url
+      @fetched = false
+    end
+
+    def fetch
+      req = HTTP.get(@url)
+      @data = JSON.parse req.body
+    end
+
+    def to_h
+      fetch unless @fetched
+      @data
+    end
+
+    def date
+      fetch unless @fetched
+      Date.parse(@date)
+    end
+
+    def unread?
+      fetch unless @fetched
+      @is_unread
+    end
+
+    def is_sender?
+      fetch unless @fetched
+      @user_is_sender
+    end
+
+    def method_missing meth
+      if vars.include? meth
+        fetch unless @fetched
+        @data[meth.to_s]
+      else
+        raise ArgumentError.new
+      end
+    end
+
+  end
+
+end

data/lib/csapi/request.rb

@@ -0,0 +1,68 @@
+module CS
+
+  class Request
+    @api = nil
+
+    attr_accessor :subject, :number, :arrival_flexible, :departure_flexible, :is_open_couchrequest, :from, :to, :arrival, :departure, :message
+
+    @options = [:subject, :number, :arrival_flexible, :departure_flexible, :is_open_couchrequest, :from, :to, :arrival, :departure, :message]
+
+    @defaults = {
+      subject: "A ruby programmer wants to surf your couch!",
+      number: 1,
+      arrival_flexible: false,
+      departure_flexible: false,
+      is_open_couchrequest: false,
+      from: nil,
+      to: nil,
+      arrival: Time.now,
+      departure: (Time.now+3600),
+      message: "I'm to lazy to write a proper couch request. HOST ME PLZ?"
+    }
+
+
+    def initialize options={}
+      options = @defaults.merge(options)
+      options.each do |k,v|
+        self.send "@#{k}=", val
+      end
+    end
+
+
+    def arrival= date
+      raise ArgumentError.new("This does not seem like a Time instance") unless date.is_a? Time
+      @arrival = date
+    end
+
+
+    def departure= date
+      raise ArgumentError.new("This does not seem like a Time instance") unless date.is_a? Time
+      @departure = date
+    end
+
+
+    def to_h
+      params = {}
+      @options.each {|key| params[key.to_sym] = instance_variable_get("@#{key}") }
+      params
+    end
+
+
+    def send!
+      raise CS::APIError('You have not authenticated with the service or did not provide a :username and :password') unless CS.instance
+
+      data = self.to_h
+      data[:arrival] = data[:arrival].strftime("%FT%TZ")
+      data[:departure] = data[:departure].strftime("%FT%TZ")
+
+      me = CS.instance.userdata['uid']
+      data[:from] ||= me
+      data[:to] ||= me
+
+      CS::HTTP.post('/couchrequests', body: data)
+
+    end
+
+  end
+  
+end

data/lib/csapi/search.rb

@@ -0,0 +1,85 @@
+module CS
+
+  class CouchSearch
+    attr_accessor :results, :options
+
+    @results = nil
+    @@instance = nil
+
+    def self.instance
+      @@instance
+    end
+
+    def initialize options={}
+      defaults = {
+        location: nil,
+        gender: nil,
+        :'has-photo' => nil,
+        :'member-type' => 'host' ,
+        vouched: nil,
+        verified: nil,
+        network: nil,
+        :'min-age' => nil,
+        :'max-age' => nil,
+        :platform => 'android'
+      }
+
+      @options = options.merge(defaults)
+      @@instance = self
+      
+    end
+
+
+    def execute
+      html = HTTP.get('/msearch', :query => @options)
+      doc = Nokogiri::HTML(html);
+      users = {}
+      statuses = {
+        'M' => 'maybe',
+        'T' => 'travelling',
+        'Y' => 'available',
+        'N' => 'unavailable'
+      }
+      doc.xpath('//article').each do |article|
+        id = article.at_css('a').attr('href').split('/').last
+        user = {
+          string_id: article.attr('rel'),
+          name: article.children.at_css("h2").content,
+          location: article.children.at_css("div.location").content,
+          status: statuses[article['class'].match(/couch-([A-Z])/)[1]],
+          pic: article.at_css('img').attr('src')
+        }
+        users[id] = user
+      end
+      
+      @results = CS::SearchResults.new(users)
+      @results
+    end
+
+
+    def more
+      @options[:page] = (@options[:page]||0)+1
+      @options[:exclude_ids] = results.collect {|k, u| u[:string_id]}
+      results
+    end
+
+  end
+
+	class SearchResults
+    include Enumerable
+    attr_accessor :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def method_missing meth, *args, &block
+      @data.send(meth.to_sym, *args, &block)
+    end
+
+    def more
+      CS::CouchSearch.instance.more
+    end
+  
+	end
+end

data/lib/csapi/version.rb

@@ -1,3 +1,3 @@
 module CS
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/readme.md

@@ -1,7 +1,11 @@
 This is a simple CouchSurfing API
 =================================
 
-This used to be a PHP app, but I just changed my mind and went with Ruby instead. I'll probably make a PHP version soon
+This a unofficial CS API client written in Ruby.
+
+Using this client will likely result in a **violation of [Couchsurfing's TOS](https://www.couchsurfing.org/n/terms)**. I have contacted the [tech team](https://support.couchsurfing.org/hc/en-us/requests/new?category=support) as well as the [twitter](https://twitter.com/couchsurfing) folks to ask for permission of any sort to use the API, but I've yet to hear back from them.
+
+The API was reverse-engineered, and if you'd like some pointers on that, please read [unRob/CouchSurfing-API#2](https://github.com/unRob/CouchSurfing-API/pull/2#issuecomment-16404056).
 
 ##Example
 See [example.rb](https://github.com/unRob/CouchSurfing-API/blob/master/examples/example.rb)
@@ -53,4 +57,4 @@ as the name is changed.
 DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
-0. You just DO WHAT THE FUCK YOU WANT TO.
+0. You just DO WHAT THE FUCK YOU WANT TO.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: CSApi
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Roberto Hidalgo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -61,12 +61,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CONTRIBUTORS
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - Rakefile
 - csapi.gemspec
 - examples/example.rb
 - lib/csapi.rb
+- lib/csapi/errors.rb
+- lib/csapi/messages.rb
+- lib/csapi/request.rb
+- lib/csapi/search.rb
 - lib/csapi/version.rb
 - readme.md
 homepage: https://github.com/unRob/CouchSurfing-API
@@ -90,8 +95,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: I have no idea what is this
 test_files: []
+has_rdoc: false