freshmaker 0.1

data/lib/freshmaker.rb

@@ -0,0 +1,17 @@
+require 'yaml'
+AUTH = YAML::load(File.open 'conf/auth.yml')
+
+require 'freshmaker/client'
+require 'freshmaker/ticket_proxy'
+require 'freshmaker/user_proxy'
+require 'freshmaker/version'
+
+module Freshmaker
+  class << self
+    attr_writer :email, :password
+
+    def new
+      Freshmaker::Client.new(@email, @password)
+    end
+  end
+end

data/lib/freshmaker/client.rb

@@ -0,0 +1,26 @@
+require 'httparty'
+
+module Freshmaker
+  class Client
+    include HTTParty
+
+    base_uri AUTH['url']
+
+    def initialize(email, password)
+      @auth = { username: email, password: password }
+    end
+
+    def get(path, options={})
+      options.merge!({ basic_auth: @auth })
+      self.class.get("#{path}.xml?", options)
+    end
+
+    def users
+      Freshmaker::UserProxy.new(self)
+    end
+
+    def tickets
+      Freshmaker::TicketProxy.new(self)
+    end
+  end
+end

data/lib/freshmaker/ticket_proxy.rb

@@ -0,0 +1,12 @@
+module Freshmaker
+  class TicketProxy
+    def initialize(client)
+      @client = client
+    end
+
+    def get(email)
+      response = @client.get('/helpdesk/tickets/user_ticket', query: { email: email })
+      response['helpdesk_tickets'] || []
+    end
+  end
+end

data/lib/freshmaker/user_proxy.rb

@@ -0,0 +1,25 @@
+module Freshmaker
+  class UserProxy
+    def initialize(client)
+      @client = client
+    end
+
+    def all
+      all  = []
+      page = 1
+
+      begin
+        users = get(page: page)
+        all  += users
+        page += 1
+      end while users.present?
+
+      all
+    end
+
+    def get(params={})
+      response = @client.get('/contacts', query: params)
+      response['users'] || []
+    end
+  end
+end

data/lib/freshmaker/version.rb

@@ -0,0 +1,3 @@
+module Freshmaker
+  VERSION = '0.1'
+end

data/spec/freshmaker/client_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Freshmaker::Client do
+  subject { Freshmaker::Client }
+
+  let(:email)    { AUTH['email'] }
+  let(:password) { AUTH['password'] }
+  let(:client)   { Freshmaker::Client.new(email, password) }
+
+  describe '#initialize' do
+    context 'authorization' do
+      subject { client.instance_variable_get(:@auth) }
+
+      it { should be_a(Hash) }
+      its([:username]) { should eql(email) }
+      its([:password]) { should eql(password) }
+    end
+  end
+
+  describe '#get' do
+    it 'should return an HTTParty response' do
+      response = client.get('/contacts')
+      response.class.should be(HTTParty::Response)
+    end
+  end
+
+  describe '#users' do
+    subject { client.users }
+    it { should be_an_instance_of(Freshmaker::UserProxy) }
+  end
+
+  describe '#tickets' do
+    subject { client.tickets}
+    it { should be_an_instance_of(Freshmaker::TicketProxy) }
+  end
+end

data/spec/freshmaker/ticket_proxy_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Freshmaker::TicketProxy do
+  let(:fd_email)    { AUTH['email'] }
+  let(:fd_password) { AUTH['password'] }
+  let(:client)   { Freshmaker::Client.new(fd_email, fd_password) }
+
+  let(:ticket_proxy) { Freshmaker::TicketProxy.new(client) }
+
+  describe '.initialize' do
+    it 'should set the client' do
+      ticket_proxy.instance_variable_get(:@client).should eql(client)
+    end
+  end
+
+  describe '.get' do
+    let(:email) { 'tal@safran.com' }
+
+    context 'gets a response' do
+      before(:all) do
+        @tickets = ticket_proxy.get(email)
+      end
+
+      it 'should return a response' do
+        @tickets.should be
+      end
+
+      it 'should be an array of tickets' do
+        @tickets.should be_an(Array)
+      end
+
+      it 'should have all the fields we want' do
+        @tickets.each do |ticket|
+          ticket.should have_key('description')
+          ticket.should have_key('subject')
+          ticket.should have_key('due_by')
+          ticket.should have_key('display_id')
+          ticket.should have_key('requester_id')
+          ticket.should have_key('responder_id')
+          ticket.should have_key('created_at')
+          ticket.should have_key('updated_at')
+
+          ticket['notes'].each do |note|
+            note.should have_key('body')
+            note.should have_key('incoming')
+            note.should have_key('private')
+            note.should have_key('id')
+            note.should have_key('user_id')
+            note.should have_key('created_at')
+            note.should have_key('updated_at')
+          end
+        end
+      end
+    end
+
+    context 'empty response' do
+      it 'should return an empty array' do
+        Freshmaker::Client.stub(:get).and_return({})
+        ticket_proxy.get(email).should == []
+      end
+    end
+  end
+end

data/spec/freshmaker/user_proxy_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Freshmaker::UserProxy do
+  let(:fd_email)    { AUTH['email'] }
+  let(:fd_password) { AUTH['password'] }
+  let(:client)   { Freshmaker::Client.new(fd_email, fd_password) }
+
+  let(:user_proxy) { Freshmaker::UserProxy.new(client) }
+
+  describe '.initialize' do
+    it 'should set the client' do
+      user_proxy.instance_variable_get(:@client).should eql(client)
+    end
+  end
+
+  describe '.get' do
+    let(:email) { 'tal@safran.com' }
+
+    context 'gets a response' do
+      before(:all) do
+        @users = user_proxy.get
+      end
+
+      it 'should return a response' do
+        @users.should be
+      end
+
+      it 'should be an array' do
+        @users.should be_an(Array)
+      end
+
+      it 'should have at most 10 users on a page' do
+        @users.count.should <= 10
+      end
+
+      context 'each user' do
+        it 'should have all the attributes we need' do
+          @users.each do |user|
+            user['name'].should be
+            user['id'].should be
+            user['email'].should be
+          end
+        end
+      end
+    end
+
+    context 'empty response' do
+      it 'should return an empty array' do
+        Freshmaker::Client.stub(:get).and_return({})
+        user_proxy.get.should == []
+      end
+    end
+  end
+end

data/spec/freshmaker_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Freshmaker do
+  describe '#new' do
+    subject { Freshmaker.new }
+    it { should be_an_instance_of(Freshmaker::Client) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'freshmaker'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: freshmaker
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Tal Safran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70289799300140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70289799300140
+description: A simple API wrapper for Freshmaker.
+email: tal@talsafran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/freshmaker.rb
+- lib/freshmaker/client.rb
+- lib/freshmaker/ticket_proxy.rb
+- lib/freshmaker/user_proxy.rb
+- lib/freshmaker/version.rb
+- spec/freshmaker/client_spec.rb
+- spec/freshmaker/ticket_proxy_spec.rb
+- spec/freshmaker/user_proxy_spec.rb
+- spec/freshmaker_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/talsafran/freshmaker
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Freshmaker – A simple API wrapper for Freshmaker.
+test_files: []