singly 0.1.0 → 0.1.1

data/lib/singly/api/services/soundcloud.rb

@@ -4,8 +4,7 @@ module Singly
       include Singly::Endpoint
       include Singly::Services::Service
 
-      service :soundcloud
-
+      
       def self(params={})
         service_endpoint(__method__, params)
       end

data/lib/singly/api/services/stocktwits.rb

@@ -4,8 +4,7 @@ module Singly
       include Singly::Endpoint
       include Singly::Services::Service
 
-      service :stocktwits
-
+      
       def self(params={})
         service_endpoint(__method__, params)
       end

data/lib/singly/api/services/tout.rb

@@ -4,8 +4,7 @@ module Singly
       include Singly::Endpoint
       include Singly::Services::Service
 
-      service :tout
-
+      
       def self(params={})
         service_endpoint(__method__, params)
       end

data/lib/singly/api/services/tumblr.rb

@@ -4,8 +4,7 @@ module Singly
       include Singly::Endpoint
       include Singly::Services::Service
 
-      service :tumblr
-
+      
       def self(params={})
         service_endpoint(__method__, params)
       end

data/lib/singly/api/services/twitter.rb

@@ -4,8 +4,7 @@ module Singly
       include Singly::Endpoint
       include Singly::Services::Service
 
-      service :twitter
-
+      
       def self(params={})
         service_endpoint(__method__, params)
       end

data/lib/singly/api/services/withings.rb

@@ -4,8 +4,7 @@ module Singly
       include Singly::Endpoint
       include Singly::Services::Service
 
-      service :withings
-
+      
       def self(params={})
         service_endpoint(__method__, params)
       end

data/lib/singly/api/services/wordpress.rb

@@ -4,8 +4,7 @@ module Singly
       include Singly::Endpoint
       include Singly::Services::Service
 
-      service :wordpress
-
+      
       def self(params={})
         service_endpoint(__method__, params)
       end

data/lib/singly/api/services/yammer.rb

@@ -4,8 +4,7 @@ module Singly
       include Singly::Endpoint
       include Singly::Services::Service
 
-      service :yammer
-
+      
       def self(params={})
         service_endpoint(__method__, params)
       end

data/lib/singly/api/services/youtube.rb

@@ -4,8 +4,7 @@ module Singly
       include Singly::Endpoint
       include Singly::Services::Service
 
-      service :youtube
-
+      
       def self(params={})
         service_endpoint(__method__, params)
       end

data/lib/singly/api/services/zeo.rb

@@ -4,8 +4,7 @@ module Singly
       include Singly::Endpoint
       include Singly::Services::Service
 
-      service :zeo
-
+      
       def self(params={})
         service_endpoint(__method__, params)
       end

data/lib/singly/endpoint.rb

@@ -8,71 +8,86 @@
 #
 module Singly
   module Endpoint
-    attr_reader :type
-    attr_reader :route
-    attr_reader :route_params
-    attr_reader :query_params
+    attr_reader :path
+    attr_reader :options
 
     def initialize(params={})
-      params = params || {}
-      @route = self.class.route
-      @type = self.class.type
-      route_param_keys = self.class.required_route_params
-      @query_params = params.reject{|key| route_param_keys.include? key }
-      @route_params = params.select{|key| route_param_keys.include? key }
+      init_path(params)
+      init_options(params)
     end
 
-    def fetch
+    # The opts argument is for Typhoeus overrides
+    def fetch(opts={})
       validate
-      Singly::Http.fetch(type, path, query_params)
+      Singly::Http.fetch(path, options.merge(opts))
     end
 
     # Raises an error if any required parameters have not been
     # supplied or if any path components are missing.
     def validate
-      missing_route_params = self.class.required_route_params - route_params.keys
-      Singly::Error.y_u_no?("has route params :#{missing_route_params.join(', :')}") { missing_route_params.any? }
-      missing_query_params = self.class.required_params - query_params.keys
-      Singly::Error.y_u_no?("has query params :#{missing_query_params.join(', :')}") { missing_query_params.any? }
+      Singly::Error.y_u_no?("has all route params: #{path}") { path.include? ":" }
+      missing_options = self.class.required_params - options[:params].keys
+      Singly::Error.y_u_no?("has required params :#{missing_options.join(', :')}") { missing_options.any? }
       true  
     end
 
-    # Constructs the path by replacing path components
-    # defined in the route with their corresponding 
-    # values in the @parameters attribute.
-    # "/profiles/:id@:service" -> "/profiles/12345@twitter"
-    def path
-      route_params.inject(route) do |route, param|
-        route.sub(":#{param[0]}", CGI.escape("#{param[1]}"))
-      end
-    end
-
     # String representation of the composed endpoint.
     # Parameter order is deterministic so it can be
     # used as a key in the /multi endpoint.
     def url
       validate
-      query_string = query_params.sort.inject([]) do |queries, param|
+      query_string = options[:params].sort.inject([]) do |queries, param|
         queries << ("#{CGI.escape(param[0].to_s)}=#{CGI.escape(param[1].to_s)}")
       end.join("&")
       url = "#{Singly::Http.base_url}#{path}"
       url += "?#{query_string}" unless query_string.empty?
-      return url
+      url
     end
 
     private
 
+    # Constructs the path by replacing route components
+    # with their corresponding values specified in the
+    # params argument.
+    # "/profiles/:id@:service" -> "/profiles/12345@twitter"
+    def init_path(params)
+      route = self.class.route
+      route_keys = route.scan(/:(\w+)/).flatten
+      @path = route_keys.inject(route) do |path, key|
+        value = params.delete(key.to_sym)
+        value ? path.sub(":#{key}", CGI.escape("#{value}")) : path
+      end
+    end
+
+    def init_options(params)
+      @options = {
+        method: self.class.http_method, 
+        timeout: Singly.timeout,
+        params: {}
+      }
+      if [:post, :put].include? @options[:method]
+        # Always send credentials in the url
+        @options[:params][:access_token] = params.delete(:access_token) if params[:access_token]
+        @options[:params][:client_id] = params.delete(:client_id) if params[:client_id]
+        @options[:params][:client_id] = params.delete(:client_secret) if params[:client_secret]
+        @options[:body] = params
+      else
+        @options[:params] = params
+      end
+      @options
+    end
+
     # Use this to pass credentials down the pipe
     # eg: 
     #   def photos(params={})
     #     Singly::Services::Facebook.new(creds.merge(params))
     #   end
     def creds
-      creds = {}
-      creds[:access_token] = query_params[:access_token] if query_params[:access_token]
-      creds[:client_id] = query_params[:client_id] if query_params[:client_id]
-      creds[:client_secret] = query_params[:client_secret] if query_params[:client_secret]
-      creds
+      [:access_token, :client_id, :client_secret].inject({}) do |creds, cred_key|
+        cred = options[:params][cred_key]
+        creds[cred_key] = cred if cred
+        creds
+      end
     end
 
     def self.included(base)
@@ -80,18 +95,14 @@ module Singly
     end
 
     module ClassMethods
-      def type
-        @type || :get
+      def http_method
+        @http_method || :get
       end
 
       def route
         @route || ""
       end
 
-      def required_route_params
-        route.scan(/:(\w+)/).flatten.map(&:to_sym)
-      end
-
       def required_params
         (@params && @params[:required]) || []
       end
@@ -100,10 +111,8 @@ module Singly
         (@params && @params[:optional]) || []
       end
 
-      private
-
-      def endpoint(type, route, params={})
-        @type = type
+      def endpoint(http_method, route, params={})
+        @http_method = http_method
         @route = route
         @params = params
       end

data/lib/singly/error.rb

@@ -12,13 +12,15 @@ module Singly
     end
   end
   class ApiError < Error
-    def initialize(response)
-      super("#{response.code} #{response.body} #{response.effective_url}")
+    attr_reader :response
+    def initialize(response, msg=nil)
+      @response = response
+      super(msg || "HTTP #{response.code} #{response.body}")
     end
   end
-  class TimeoutError < Error
+  class TimeoutError < ApiError
     def initialize(response)
-      super("Response timed out after #{response.time} seconds. #{response.effective_url}")
+      super(response, "Timed out after #{response.time} seconds")
     end
   end
 end

data/lib/singly/http.rb

@@ -7,22 +7,21 @@ module Singly
         "https://api.singly.com/#{Singly.version}"
       end
 
-      def fetch(type, path, params={})
-        path = "#{base_url}#{path}"
-        log("#{type.upcase} #{path}")
-        log("PARAMS #{params}")
-        response = Typhoeus::Request.send(type, path, params: params, timeout: Singly.timeout)
+      def fetch(path, options={})
+        log("#{path} with #{options}")
+        response = Typhoeus::Request.new("#{base_url}#{path}", options).run
         validate_response(response)
         parse_response(response)
       end
 
       private
 
-      # Singly does not yet guarantee that all responses conform to 
-      # valid json. Sometimes we can get a TypeError
+      # Naive response handling.
+      # Singly sometimes returns invalid json with the application/json
+      # content type. For example, a simple "true" is received from
+      # the POST /profiles/self endpoint.
       def parse_response(response)
         body = response.body
-        log(body)
         JSON.parse(body) rescue body
       end
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Singly
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/integration/account/apply_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe "Singly.account(:access_token).merge" do
+  let(:account) { Singly.account("TOKEN_STUB", "ACCOUNT_ID_STUB") }
+  before { Singly.client_id = "CLIENT_ID_STUB" }
+  before { Singly.client_secret = "CLIENT_SECRET_STUB" }
+  describe "GET /auth/:service/apply with Oauth1 service" do
+    subject { account.apply(:flickr, token: "a_token", token_secret: "a_secret") }
+    it { subject.validate.should == true }
+    it { subject.path.should == "/auth/flickr/apply" }
+    it { subject.options.should include(
+      method: :get,
+      params: {
+        token: "a_token",
+        token_secret: "a_secret",
+        account: "ACCOUNT_ID_STUB",
+        client_id: "CLIENT_ID_STUB",
+        client_secret: "CLIENT_SECRET_STUB"
+      }
+    )}
+  end
+  describe "GET /auth/:service/apply with Oauth1 service" do
+    subject { account.apply(:facebook, token: "a_token") }
+    it { subject.validate.should == true }
+    it { subject.path.should == "/auth/facebook/apply" }
+    it { subject.options.should include(
+      method: :get,
+      params: {
+        token: "a_token",
+        account: "ACCOUNT_ID_STUB",
+        client_id: "CLIENT_ID_STUB",
+        client_secret: "CLIENT_SECRET_STUB"
+      }
+    )}
+  end
+end

data/spec/integration/account/delete_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe "Singly.account(:access_token).delete" do
+  let(:account) { Singly.account("TOKEN_STUB") }
+  describe "DELETE /profiles/:service" do
+    subject { account.delete(:instagram) }
+    it { subject.validate.should == true }
+    it { subject.path.should == "/profiles/instagram" }
+    it { subject.options.should include(
+      method: :delete,
+      params: { access_token: "TOKEN_STUB" }
+    )}
+  end
+  describe "DELETE /profiles/:id@:service" do
+    subject { account.delete(:foursquare, "123abc") }
+    it { subject.validate.should == true }
+    it { subject.path.should == "/profiles/123abc@foursquare" }
+    it { subject.options.should include(
+      method: :delete,
+      params: { access_token: "TOKEN_STUB" }
+    )}
+  end
+end

data/spec/integration/account/friends_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe "Singly.account(:access_token).friends" do
+  let(:account) { Singly.account("TOKEN_STUB") }
+  describe "GET /friends" do
+    subject { account.friends }
+    it { subject.validate.should == true }
+    it { subject.path.should == "/friends" }
+    it { subject.options.should include(
+      method: :get,
+      params: { access_token: "TOKEN_STUB" }
+    )}
+  end
+  describe "GET /friends/:group" do
+    subject { account.friends.peers }
+    it { subject.validate.should == true }
+    it { subject.path.should == "/friends/peers" }
+    it { subject.options.should include(
+      method: :get,
+      params: { access_token: "TOKEN_STUB" }
+    )}
+  end
+  describe "GET /friends/:group with optional params" do
+    subject { account.friends.all({
+      limit: 10,
+      offset: 3,
+      services: "facebook,linkedin",
+      full: true,
+      sort: "interactions",
+      toc: false,
+      q: "kevrone",
+      bio: "Timehop"
+    }) }
+    it { subject.validate.should == true }
+    it { subject.path.should == "/friends/all" }
+    it { subject.options.should include(
+      method: :get,
+      params: {
+        access_token: "TOKEN_STUB",
+        limit: 10,
+        offset: 3,
+        services: "facebook,linkedin",
+        full: true,
+        sort: "interactions",
+        toc: false,
+        q: "kevrone",
+        bio: "Timehop"
+      }
+    )}
+  end
+end

data/spec/integration/account/id_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe "Singly.account(:access_token).id" do
+  let(:account) { Singly.account("TOKEN_STUB") }
+  describe "GET /id/:id" do
+    subject { account.id("photo:123456@facebook/photos#987654321") }
+    it { subject.validate.should == true }
+    it { subject.path.should == "/id/photo%3A123456%40facebook%2Fphotos%23987654321" }
+    it { subject.options.should include(
+      method: :get,
+      params: { access_token: "TOKEN_STUB" }
+    )}
+  end
+  describe "GET /id/:id with optional params" do
+    subject { account.id("photo:123456@facebook/photos#987654321", map: true) }
+    it { subject.validate.should == true }
+    it { subject.path.should == "/id/photo%3A123456%40facebook%2Fphotos%23987654321" }
+    it { subject.options.should include(
+      method: :get,
+      params: { access_token: "TOKEN_STUB", map: true }
+    )}
+  end
+end