twelve 0.1.0

data/lib/twelve/api/gauges/engines.rb

@@ -0,0 +1,32 @@
+class Twelve
+
+  # API module encapsulates all of the API endpoints
+  #
+  module API
+
+    # The Gauges module handles Gauges on Gauges
+    #
+    module Gauges
+
+      # The Engines module handles accessing search engines
+      #
+      module Engines
+
+        # Returns monthly engines for a gauge
+        #
+        # date - String of date
+        #
+        # Returns json
+        #
+        def engines(date=nil)
+          attributes = {}
+
+          connection.get do |request|
+            request.url "#{path_prefix}/engines"
+            request.params['date'] = date if date && date.is_a?(String)
+          end.body
+        end
+      end
+    end
+  end
+end

data/lib/twelve/api/gauges/locations.rb

@@ -0,0 +1,32 @@
+class Twelve
+
+  # API module encapsulates all of the API endpoints
+  #
+  module API
+
+    # The Gauges module handles Gauges on Gauges
+    #
+    module Gauges
+
+      # The Locations module handles accessing locations
+      #
+      module Locations
+
+        # Returns monthly locations for a gauge
+        #
+        # date - String of date
+        #
+        # Returns json
+        #
+        def locations(date=nil)
+          attributes = {}
+
+          connection.get do |request|
+            request.url "#{path_prefix}/locations"
+            request.params['date'] = date if date && date.is_a?(String)
+          end.body
+        end
+      end
+    end
+  end
+end

data/lib/twelve/api/gauges/referrers.rb

@@ -0,0 +1,36 @@
+class Twelve
+
+  # API module encapsulates all of the API endpoints
+  #
+  module API
+
+    # The Gauges module handles Gauges on Gauges
+    #
+    module Gauges
+
+      # The Referrers module handles referrers
+      #
+      module Referrers
+
+        # Returns top content for a gauge
+        #
+        # *args - Date string & options hash
+        #
+        # Returns json
+        #
+        def referrers(*args)
+          attributes = {}
+
+          connection.get do |request|
+            request.url "#{path_prefix}/referrers"
+
+            args.each do |arg|
+              request.params['page'] = arg[:page].to_s if arg.is_a?(Hash) && arg.has_key?(:page)
+              request.params['date'] = arg if arg.is_a?(String)
+            end
+          end.body
+        end
+      end
+    end
+  end
+end

data/lib/twelve/api/gauges/resolutions.rb

@@ -0,0 +1,32 @@
+class Twelve
+
+  # API module encapsulates all of the API endpoints
+  #
+  module API
+
+    # The Gauges module handles Gauges on Gauges
+    #
+    module Gauges
+
+      # The Resolutions module handles accessing screen resolutions
+      #
+      module Resolutions
+
+        # Returns monthly screen sizes for a gauge
+        #
+        # date - String of date
+        #
+        # Returns json
+        #
+        def resolutions(date=nil)
+          attributes = {}
+
+          connection.get do |request|
+            request.url "#{path_prefix}/resolutions"
+            request.params['date'] = date if date && date.is_a?(String)
+          end.body
+        end
+      end
+    end
+  end
+end

data/lib/twelve/api/gauges/shares.rb

@@ -0,0 +1,45 @@
+class Twelve
+
+  # API module encapsulates all of the API endpoints
+  #
+  module API
+
+    # The Gauges module handles Gauges on Gauges
+    #
+    module Gauges
+
+      # The Shares module handles sharing gauges
+      #
+      module Shares
+
+        # Get a list of users gauge is shared with
+        #
+        # Returns json
+        #
+        def shares
+          connection.get("#{path_prefix}/shares").body['shares']
+        end
+
+        # Shares a gauge with a person by their email
+        #
+        # email - String of email address
+        #
+        # Returns json
+        #
+        def share(email)
+          connection.post("#{path_prefix}/shares", email).body['share']
+        end
+
+        # Un-shares a gauge with a person by their email
+        #
+        # id - String of user id
+        #
+        # Returns json
+        #
+        def unshare(id)
+          connection.delete("#{path_prefix}/shares/#{id}").body['share']
+        end
+      end
+    end
+  end
+end

data/lib/twelve/api/gauges/technology.rb

@@ -0,0 +1,32 @@
+class Twelve
+
+  # API module encapsulates all of the API endpoints
+  #
+  module API
+
+    # The Gauges module handles Gauges on Gauges
+    #
+    module Gauges
+
+      # The Technology module handles accessing browsers and platforms
+      #
+      module Technology
+
+        # Returns monthly browsers and platforms for a gauge
+        #
+        # date - String of date
+        #
+        # Returns json
+        #
+        def technology(date=nil)
+          attributes = {}
+
+          connection.get do |request|
+            request.url "#{path_prefix}/technology"
+            request.params['date'] = date if date && date.is_a?(String)
+          end.body
+        end
+      end
+    end
+  end
+end

data/lib/twelve/api/gauges/terms.rb

@@ -0,0 +1,36 @@
+class Twelve
+
+  # API module encapsulates all of the API endpoints
+  #
+  module API
+
+    # The Gauges module handles Gauges on Gauges
+    #
+    module Gauges
+
+      # The Terms module handles search terms
+      #
+      module Terms
+
+        # Returns search terms for a gauge
+        #
+        # *args - Date string & options hash
+        #
+        # Returns json
+        #
+        def terms(*args)
+          attributes = {}
+
+          connection.get do |request|
+            request.url "#{path_prefix}/terms"
+
+            args.each do |arg|
+              request.params['page'] = arg[:page].to_s if arg.is_a?(Hash) && arg.has_key?(:page)
+              request.params['date'] = arg if arg.is_a?(String)
+            end
+          end.body
+        end
+      end
+    end
+  end
+end

data/lib/twelve/api/gauges/traffic.rb

@@ -0,0 +1,32 @@
+class Twelve
+
+  # API module encapsulates all of the API endpoints
+  #
+  module API
+
+    # The Gauges module handles Gauges on Gauges
+    #
+    module Gauges
+
+      # The Traffic module handles accessing traffic
+      #
+      module Traffic
+
+        # Returns monthly traffic for a gauge
+        #
+        # date - String of date
+        #
+        # Returns json
+        #
+        def traffic(date=nil)
+          attributes = {}
+
+          connection.get do |request|
+            request.url "#{path_prefix}/traffic"
+            request.params['date'] = date if date && date.is_a?(String)
+          end.body
+        end
+      end
+    end
+  end
+end

data/lib/twelve/api/me.rb

@@ -0,0 +1,28 @@
+class Twelve
+
+  # API module encapsulates all of the API endpoints
+  #
+  module API
+
+    # The Me module handles your information on Gauges
+    #
+    module Me
+
+      # Get and Update your information, accepts attributes
+      #
+      # attributes - Hash of attributes to update
+      #
+      # Returns json
+      #
+      def me(attributes=nil)
+        response = if attributes
+          connection.put('/me', attributes)
+        else
+          connection.get('/me')
+        end
+
+        response.body['user']
+      end
+    end
+  end
+end

data/lib/twelve/connection.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'multi_json'
+
+class Twelve
+  class Connection < Faraday::Connection
+    attr_reader :access_token
+
+    # Instantiates connection, requires an access_token
+    #
+    # access_token - String of the access token
+    #
+    def initialize(access_token=nil)
+      @access_token = access_token
+
+      super('https://secure.gaug.es') do |builder|
+        builder.request   :url_encoded
+        builder.use       Faraday::Response::ParseJson
+        builder.adapter   Faraday.default_adapter
+      end
+
+      self.headers["X-Gauges-Token"] = "#{access_token}" if access_token
+      self.headers["Accept"] = 'application/json'
+    end
+  end
+end

data/lib/twelve/resource_proxy.rb

@@ -0,0 +1,46 @@
+class Twelve
+
+  # ResourceProxy lets us create a virtual
+  # proxy for any API resource, utilizing
+  # method_missing to handle passing
+  # messages to the real object
+  #
+  class ResourceProxy
+
+    # Undefine methods that might get in the way
+    instance_methods.each { |m| undef_method m unless m =~ /^__|instance_eval|instance_variable_get|object_id/ }
+
+    # Make connection and path_prefix readable
+    attr_reader :connection, :path_prefix, :attributes
+
+    # Instantiates proxy with the connection
+    # and path_prefix
+    #
+    # connection - Twelve::Connection object
+    # path_prefix - String
+    #
+    def initialize(connection, path_prefix, attributes=nil)
+      @connection, @path_prefix, @attributes = connection, path_prefix, attributes
+    end
+
+    # Method_missing takes any message passed
+    # to the ResourceProxy and sends it to the
+    # real object
+    #
+    # message - Message object
+    # args* - Arguements passed
+    #
+    def method_missing(message, *args)
+      subject.send(message, *args)
+    end
+
+    # Subject is the response body parsed
+    # as json
+    #
+    # Returns json
+    #
+    def subject
+      raise "Implement in Proxy class for resource"
+    end
+  end
+end

data/lib/twelve/version.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+class Twelve
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+require 'bundler'
+Bundler.require :default, :test
+require 'webmock/rspec'
+require 'vcr'
+require 'twelve'
+
+VCR.config do |c|
+  c.cassette_library_dir = File.expand_path('../responses', __FILE__)
+  c.stub_with :webmock
+  c.default_cassette_options = {:record => :once}
+end
+
+token_file = File.expand_path('../.access_token', __FILE__)
+ACCESS_TOKEN = File.exists?(token_file) ? File.read(token_file).strip : 'faketoken'
+gauge_file = File.expand_path('../.gauge_id', __FILE__)
+GAUGE_ID = File.exists?(gauge_file) ? File.read(gauge_file).strip : 'fakegaugeid'

data/spec/twelve/api/clients_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Twelve::API::Clients do
+  subject { Twelve.new(ACCESS_TOKEN) }
+
+  def should_be_a_client(client)
+    client['created_at'].should_not be_nil
+    client['urls']['self'].should == "https://secure.gaug.es/clients/#{client['key']}"
+    client.should have_key('description')
+  end
+
+  describe "#clients" do
+    it "returns a list of your API clients" do
+      VCR.use_cassette('clients') do
+        clients = subject.clients
+        clients.should be_instance_of(Array)
+        clients.size.should > 0
+        should_be_a_client(clients.first)
+      end
+    end
+
+    describe "#create" do
+      it "returns created client" do
+        VCR.use_cassette('clients_create') do
+          client = subject.clients.create(:description => "12 Gauge")
+          should_be_a_client(client)
+          # cleanup
+          subject.clients(client['key']).destroy
+        end
+      end
+    end
+
+    describe "#destroy" do
+      it "returns deleted client" do
+        VCR.use_cassette('clients_delete') do
+          delete = subject.clients.create(:description => "Testing Twelve")
+          client = subject.clients(delete['key']).destroy
+          should_be_a_client(client)
+        end
+      end
+    end
+  end
+end