zendesk_api 0.1.11 → 0.2.1

data/lib/zendesk_api/server/templates/footer.haml

@@ -0,0 +1,13 @@
+%footer.container.footer
+  %small
+    We will never store your username, password or API token.
+  .footer_links
+    %span.footer_item
+      %a{:href => "http://www.zendesk.com"} Zendesk
+    %span.footer_item
+      %a{:href => "http://www.zendesk.com/signup"} Signup
+    %span.footer_item
+      %a{:href => "http://www.zendesk.com/integrations"} Integrations
+    %span.copyright
+      ©2012 Zendesk
+

data/lib/zendesk_api/server/templates/header.haml

@@ -0,0 +1,20 @@
+.navbar.navbar-fixed-top
+  .navbar-inner
+    .container
+      %a{:href => url("/")}
+        %img.logo-lotus{:src => url("/images/zendesk_developers_header.png")}
+
+      %ul.nav.pull-right
+        %li
+          %a{:href => "http://developer.zendesk.com/documentation/rest_api/introduction.html"} REST API
+        %li
+          %a{:href => "http://developer.zendesk.com/documentation/apps"} Apps
+        %li
+          %a{:href => "http://developer.zendesk.com/blog/index.html"} Blog
+        %li
+          %a{:href => "https://support.zendesk.com/forums/20636018-zendesk-api"} Community
+        %li
+          %a{:href => "https://support.zendesk.com"} Support
+
+      %form.navbar-search.pull-left{:action => "http://developer.zendesk.com/search", :method => "get"}
+        %input.search-query.span2{:type => "text", :name => "q", :placeholder => "Search"}

data/lib/zendesk_api/server/templates/index.haml

@@ -0,0 +1,68 @@
+%form.form{:method => :post, :action => url("/")}
+  .form-inline
+    %input.input-xlarge{:id => "username", :name => "username", :placeholder => "username", :type => "text", :value => params["username"]}
+    %input.input-xlarge{:id => "password", :name => "password", :placeholder => "password / token", :type => "password", :value => params["password"]}
+
+  %input#path{:name => "url", :type => "text", :value => full_url, :placeholder => "https://{subdomain}.zendesk.com/api/v2/{path}.json"}
+
+  #input
+    #params
+      - (@url_params || {}).each do |param|
+        = haml :param, :locals => { :param => param }
+
+    %button.btn#add-param{:type => "button"}
+      Add URL Parameter
+
+    #possible-params{:href => "#"}
+      %i.icon-plus
+      %i.icon-minus.hide
+      Valid URL Parameters
+
+    #possible-params-text.hide.alert.alert-info
+      per_page, page, includes, sort_order
+      %small.inline (these may not be honored for all requests)
+
+    %textarea#json.hide{:name => "json", :placeholder => '{ "": "" }'}= @json
+
+  %select#method-select{:name => "method"}
+    - %w{GET POST PUT DELETE}.each do |method|
+      %option{:value => method, :selected => @method == method.downcase.to_sym}= method
+
+  %button.btn.btn-primary{:type => :submit}
+    Submit
+
+#response
+  - if @html_request && @html_response
+    %ul.nav.nav-pills
+      %li
+        %a.tab-link#request-tab-link{:href => "#request"}
+          Request
+      %li.active
+        %a.tab-link#response-tab-link{:href => "#response"}
+          Response
+
+  - if @error
+    .alert.alert-error
+      %button.close{:type => "button", "data-dismiss" => "alert"} x
+      %span= "Error: #{@error}"
+
+  - if @html_request
+    #request-tab.code.tab.hide
+      %pre= @html_request
+
+  - if @html_response
+    #response-tab.code.tab
+      %pre= @html_response
+
+- if @user_request
+  - url = url("/#{@user_request._id}")
+
+  You can access this request again at
+  %a{:href => url}= url
+  %small.inline (your password isn't stored)
+
+:javascript
+  $("#add-param").click(function(event) {
+    event.preventDefault();
+    $("#params").append(#{haml(:param, :locals => { :param => {} }).to_json});
+  });

data/lib/zendesk_api/server/templates/layout.haml

@@ -0,0 +1,44 @@
+!!! 5
+%html
+  %head
+    // Bootstrap
+    %link{:rel => "stylesheet", :href => url("/stylesheets/styles.css"), :type => "text/css"}
+
+    // developers.zendesk.com Mods
+    // Stored locally because it's Non-SSL
+    // %link{:rel => "stylesheet", :href => "http://developer.zendesk.com/stylesheets/screen.css", :type => "text/css"}
+    %link{:rel => "stylesheet", :href => url("/stylesheets/developer.screen.css"), :type => "text/css"}
+
+    // Our mods
+    %link{:rel => "stylesheet", :href => url("/stylesheets/screen.css"), :type => "text/css"}
+
+    %link{:rel => "stylesheet", :href => "//ajax.googleapis.com/ajax/libs/jqueryui/1.9.0/themes/base/jquery-ui.css", :type => "text/css"}
+
+    %script{:src => "//ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"}
+    %script{:src => "//ajax.googleapis.com/ajax/libs/jqueryui/1.9.1/jquery-ui.min.js"}
+
+    %script{:src => url("/javascripts/bootstrap-alert.js")}
+    %script{:src => url("/javascripts/application.js")}
+
+    %title Zendesk API
+  %body
+    = haml :header
+
+    .container
+      .row-fluid
+        .span12.frame.well#navigation
+          %ul.nav.nav-pills
+            %li.active
+              %a.tab-link#throw-tab-link{:href => "#"}
+                Try the API
+            %li
+              %a.tab-link#help-tab-link{:href => "#documentation"}
+                Documentation
+      .row-fluid
+        .span12.frame.well.tab#throw-tab
+          = yield
+      .row-fluid
+        .span12.frame.well.hide.tab#help-tab
+          = haml :search
+
+    = haml :footer

data/lib/zendesk_api/server/templates/param.haml

@@ -0,0 +1,4 @@
+%div
+  %input.input-small{:name => "params[][name]", :value => param["name"], :placeholder => "per_page"}
+  %input.input-large{:name => "params[][value]", :value => param["value"], :placeholder => "5"}
+  %i.icon-remove.remove-param

data/lib/zendesk_api/server/templates/search.haml

@@ -0,0 +1,23 @@
+#search
+  .input-append
+    %input.input-block-level{:type => "text", :placeholder => "try: users", :name => "query"}
+    %button.btn#clear-search
+      %i.icon-remove
+
+  .alert.alert-info
+    %button.close{:type => "button", "data-dismiss" => "alert"} x
+    Begin typing and you should be able to see a list of available resources to view
+    %br
+    To go to a specific action, add the header name to the end e.g. users#list-users
+
+
+  #search-results= settings.help
+
+:javascript
+  $("#search input").autocomplete({
+    source: #{settings.autocomplete.to_json},
+    minLength: 3,
+    select: function(event, ui) {
+      search(ui.item.value);
+    }
+  });

data/lib/zendesk_api/server/templates/sidebar.haml

@@ -0,0 +1,7 @@
+%ul.nav.nav-pills
+  %li
+    %a{:href => "http://zendesk.com"} Zendesk
+  %li
+    %a{:href => "http://developer.zendesk.com"} Documentation
+  %li
+    %a{:href => "http://github.com/zendesk/zendesk_api_client_rb"} Ruby API Client

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "0.1.11"
+  VERSION = "0.2.1"
 end

data/spec/{association_spec.rb → core/association_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Association do
   let(:instance) { ZendeskAPI::TestResource.new(client, :id => 1) }

data/spec/{client_spec.rb → core/client_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 class SimpleClient < ZendeskAPI::Client
   def build_connection

data/spec/{collection_spec.rb → core/collection_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper.rb'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Collection do
   subject do

data/spec/{configuration_spec.rb → core/configuration_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper.rb'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Configuration do
   subject { ZendeskAPI::Configuration.new }

data/spec/{create_resource_spec.rb → core/create_resource_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::CreateResource do
   context "create" do

data/spec/{data_resource_spec.rb → core/data_resource_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::DataResource do
   specify "singular resource name" do

data/spec/{inflection_spec.rb → core/inflection_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe String do
   specify "the plural of forum if forums" do

data/spec/{lru_cache_spec.rb → core/lru_cache_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::LRUCache do
   let(:cache){ ZendeskAPI::LRUCache.new(2) }

data/spec/{middleware → core/middleware}/request/etag_cache_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Middleware::Request::EtagCache do
   it "caches" do

data/spec/{middleware → core/middleware}/request/retry_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Middleware::Request::Retry do
   def runtime

data/spec/{middleware → core/middleware}/request/upload_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 require 'tempfile'
 
 describe ZendeskAPI::Middleware::Request::Upload do

data/spec/{middleware → core/middleware}/response/callback_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Middleware::Response::Callback do
   let(:response) { "TEST" }

data/spec/{middleware → core/middleware}/response/deflate_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Middleware::Response::Deflate do
   context "with content-encoding = 'deflate'" do

data/spec/{middleware → core/middleware}/response/gzip_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Middleware::Response::Gzip do
   context "with content-encoding = 'gzip'" do

data/spec/{middleware → core/middleware}/response/parse_iso_dates_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Middleware::Response::ParseIsoDates do
   def fake_response(data)

data/spec/{read_resource_spec.rb → core/read_resource_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::ReadResource do
   context "find" do

data/spec/{rescue_spec.rb → core/rescue_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Rescue do
   include ZendeskAPI::Rescue

data/spec/{resource_spec.rb → core/resource_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Resource do
   context "#update" do

data/spec/{search_spec.rb → core/search_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Search do
   context ".new" do

data/spec/{spec_helper.rb → core/spec_helper.rb}

@@ -15,13 +15,13 @@ require 'logger'
 require 'stringio'
 require 'json'
 
-require 'resource_macros'
-require 'fixtures/zendesk'
-require 'fixtures/test_resources'
+require File.join(File.dirname(__FILE__), '..', 'macros', 'resource_macros')
+require File.join(File.dirname(__FILE__), '..', 'fixtures', 'zendesk')
+require File.join(File.dirname(__FILE__), '..', 'fixtures', 'test_resources')
 
 # tests fail when this is included in a Module (someone else also defines client)
 def client
-  credentials = File.join(File.dirname(__FILE__), "fixtures", "credentials.yml")
+  credentials = File.join(File.dirname(__FILE__), '..', 'fixtures', 'credentials.yml')
   @client ||= begin
     client = ZendeskAPI::Client.new do |config|
       if File.exist?(credentials)
@@ -111,7 +111,7 @@ RSpec.configure do |c|
 end
 
 VCR.configure do |c|
-  c.cassette_library_dir = File.join(File.dirname(__FILE__), "fixtures", "cassettes")
+  c.cassette_library_dir = File.join(File.dirname(__FILE__), '..', 'fixtures', 'cassettes')
   c.default_cassette_options = { :record => :new_episodes, :decode_compressed_response => true, :serialize_with => :json, :preserve_exact_body_bytes => true }
   c.hook_into :webmock
 end

data/spec/{trackie_spec.rb → core/trackie_spec.rb}

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Trackie do
   subject { ZendeskAPI::Trackie.new }

data/{live → spec/live}/activity_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Activity do
   it_should_be_readable :activities

data/{live → spec/live}/audit_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Ticket::Audit do
   it_should_be_readable ticket, :audits

data/{live → spec/live}/bookmark_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Bookmark, :not_findable, :delete_after do
   def valid_attributes

data/{live → spec/live}/category_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Category, :delete_after do
   def valid_attributes

data/{live → spec/live}/collection_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Collection do
   subject do

data/{live → spec/live}/crm_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::CRMData do
   # TODO

data/{live → spec/live}/custom_role_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::CustomRole do
   it_should_be_readable :custom_roles

data/{live → spec/live}/forum_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::Forum, :delete_after do
   def valid_attributes

data/{live → spec/live}/forum_subscription_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::ForumSubscription, :delete_after do
   def valid_attributes

data/{live → spec/live}/group_membership_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'core/spec_helper'
 
 describe ZendeskAPI::GroupMembership, :delete_after do
   before :all do