stdd_api 0.2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94c39aa2b325786b7f26120b520bcad03c9903ed
+  data.tar.gz: ec5c5d01cf37b468c16c08041ef33a38d926014a
+SHA512:
+  metadata.gz: fe273cebb9a1f9f9cc180398c9232801976efa599f85e7e8856a999ddeab9fbe9ddc7c9a82e2d4548e6883a0dabeb7b7b38507df562ef2f0ca9383da341bf770
+  data.tar.gz: 7259e8cbcb895342cb8c1eebc5320e5c18354a37075998200f65f60f9c33177b91c68c938b5df38e443bebb39cc72b772b929ce3cd1a4f9160110a2099757c69

data/lib/objects.rb

@@ -0,0 +1,165 @@
+module STDDAPI
+  module Objects
+    class Customer
+      def initialize(name)
+        @name = name
+      end
+      attr_accessor :name,:id
+      def to_s
+        "name: #{@name}, id: #{@id}"
+      end
+      def to_json
+        {'name' => @name}.to_json
+      end
+    end 
+
+    class Project
+      def initialize(customer_id,name)
+        @name = name
+        @customer_id = customer_id
+      end
+      attr_accessor :name,:id,:customer_id
+      def to_s
+        "name: #{@name}, customer_id: #{@customer_id}, id: #{@id}"
+      end
+      def to_json
+        {'name' => @name,'customer_id' => customer_id}.to_json
+      end
+    end
+
+    class Run
+      def initialize(project_id,name,source="",revision="")
+        @project_id = project_id
+        @name = name
+        @source = source
+        @revision = revision
+
+      end
+      attr_accessor :name,:id,:project_id,:source,:revision
+      def to_s
+        "name: #{@name}\n"+
+        "id: #{@id}\n"+
+        "project-id: #{@project_id}\n"+
+        "source: #{@source}\n"+
+        "revision: #{@revision}\n"
+      end
+      def to_json
+        {
+          'name' => @name,
+          'project_id' => @project_id,
+          'source'=> @source,
+          'revision'=>@revision
+        }.to_json
+      end
+    end
+
+    class Module
+      def initialize(run_id,name,kind,start_time)
+        @run_id = run_id
+        @name = name
+        @kind = kind
+        @start_time = start_time
+
+      end
+      attr_accessor :name,:id,:run_id,:kind,:start_time,:stop_time
+      def to_s
+        "name: #{@name}\n"+
+        "id: #{@id}\n"+
+        "run-id: #{@run_id}\n"+
+        "kind: #{@kind}\n"+
+        "start-time: #{@start_time}\n"
+      end
+      def to_json
+        {
+          'name' => @name,
+          'run_id' => @run_id,
+          'kind' => @kind,
+          'start_time'=> @start_time,
+          'stop_time'=>@stop_time
+        }.to_json
+      end
+    end
+
+    class Feature
+      def initialize(module_id,name,date)
+        @module_id = module_id
+        @name = name
+        @date = date
+        @tags = []
+      end
+      attr_accessor :name,:id,:module_id,:date,:description,:tags,:file
+      def to_s
+        "name: #{@name}\n"+
+        "id: #{@id}\n"+
+        "module-id: #{@module_id}\n"+
+        "date: #{@date}\n"+
+        "description: #{@description}\n"+
+        "tags: #{@tags}\n"+
+        "file: #{@file}\n"
+      end
+      def to_json
+        {
+          'name' => @name,
+          'module_id' => @module_id,
+          'date'=>@date,
+          'description'=>@description,
+          'tags'=>@tags,
+          'file'=>@file
+        }.to_json
+      end
+    end
+    class Scenario
+      def initialize(feature_id, name,element_type,keyword)
+        @feature_id = feature_id
+        @name = name
+        @element_type = element_type
+        @keyword = keyword
+        @tags = []
+        @steps = []
+      end
+      attr_accessor :feature_id,:keyword,:tags,:name,:element_type,:steps,:id
+      def to_json
+        {'feature_id' => @feature_id,
+          'keyword' => @keyword,
+          'name' => @name,
+          'tags' => @tags,
+          'element_type' => @element_type,
+          'steps'=>@steps
+         }.to_json
+      end
+    end
+
+    class Step
+      def initialize(scenario_id,keyword, name)
+        @keyword=keyword
+        @name=name
+        @scenario_id = scenario_id
+      end
+      attr_accessor :keyword,:name,:status,:messages,:error_message,:duration,:scenario_id
+      def to_json
+        {
+        'scenario_id'=>scenario_id,
+        'keyword' => @keyword,
+        'name' => @name ,
+        'result' => {
+          'status' =>@status,
+          'error_message'=> @error_message,
+          'duration'=>@duration
+        },
+        'messages' => @messages
+        }.to_json
+      end
+    end
+    class Embedding
+      def initialize(scenario_id,mime_type,buf)
+        @scenario_id = scenario_id
+        @mime_type = mime_type
+        @buf=buf
+      end
+      attr_accessor :mime_type,:buf,:scenario_id
+      def to_json
+        {'scenario_id'=>scenario_id ,'mime_type' => @mime_type,'buf' => @buf}.to_json
+      end
+    end
+  end
+end

data/lib/stdd_api.rb

@@ -0,0 +1,258 @@
+require 'rubygems'
+require 'cgi'
+require 'uri'
+require 'net/http'
+require_relative 'objects'
+
+module STDDAPI
+
+  class Client
+    include STDDAPI::Objects
+
+  	def initialize(stdd_url,http_proxy=nil)
+  		@url = stdd_url ? stdd_url : 'http://www.stddtool.se'
+      @proxy = http_proxy ? URI.parse('http://'+http_proxy) : OpenStruct.new
+      @connection_error = nil
+      @uri = URI.parse(@url)
+  	end
+
+    def create_customer customer_name
+      customer = Customer.new(customer_name)
+      path = "/api/create_customer"
+      valid, response = http_post path, customer.to_json
+      
+      if(valid)
+        customer = Customer.new(response["name"])
+        customer.id = response["_id"]
+        return true, customer
+      else
+        return false, response
+      end
+
+    end
+
+    def get_customer(customer_name)
+      path = "/api/get_customer"
+      path = add_params_to_path(path,{:name => customer_name})
+
+      valid, response = http_get path
+
+      
+      if(valid)
+        customer = Customer.new(response["name"]) if response["name"]
+        customer.id = response["_id"] if response["_id"]
+        return true, customer
+      else
+        return false, response
+      end
+
+    end
+
+    def create_project customer_id, project_name
+      project = Project.new(customer_id,project_name)
+      path = "/api/create_project"
+      valid, response = http_post path, project.to_json
+      
+      if(valid)
+        project = Project.new(response["customerID"],response["name"])
+        project.id = response["_id"]
+        return true, project
+      else
+        return false, response
+      end
+    end
+
+    def get_project(customer_id, project_name)
+
+      path = "/api/get_project"
+      path = add_params_to_path(path,{:customer_id => customer_id, :name => project_name})
+
+      valid, response = http_get path
+      
+      if(valid)
+        project = Project.new(response["customerID"],response["name"])
+        project.id = response["_id"]
+        return true, project
+      else
+        return false, response
+      end
+
+    end
+
+    def create_run project_id,run_name,source,revision
+      run = Run.new(project_id,run_name,source,revision)
+      path = "/api/create_run"
+      valid, response = http_post path, run.to_json
+      
+      if(valid)
+        run = Run.new(response["projectID"],response["name"],response["source"],response["revision"])
+        run.id = response["_id"]
+        return true, run
+      else
+        return false, response
+      end
+
+      
+    end
+    
+    def get_run(project_id, name)
+      path = "/api/get_run"
+      path = add_params_to_path(path,{:project_id => project_id, :name => name})
+
+      valid, response = http_get path
+      
+      if(valid)
+        run = Run.new(project_id,name)
+        run.id = response["_id"]
+        run.source = response["source"]
+        if(response["revision"])
+          run.revision = response["revision"]
+        end
+        return true, run
+      else
+        return false, response
+      end
+
+    end
+
+    def create_module run_id, name, kind, start
+      modl = Module.new(run_id,name,kind,start)
+      path = "/api/create_module"
+      valid, response = http_post path, modl.to_json
+      
+      if(valid)
+        modl = Module.new(response["runID"],response["name"],response["kind"],response["startTime"])
+        modl.id = response["_id"]
+        stop_time = response["stopTime"]
+        if(stop_time)
+          modl.stop_time = stop_time
+        end
+        return true, modl
+      else
+        return false, response
+      end
+    end
+
+    def update_module_stopTime(module_id,stop_time)
+      path = "/api/update_module_stoptime"
+      valid, response = http_post path, {"module_id" => module_id, "stop_time" => stop_time}.to_json
+      
+      if(valid)
+        modl = Module.new(response["runID"],response["name"],response["kind"],response["startTime"])
+        modl.id = response["_id"]
+        stop_time = response["stopTime"]
+        if(stop_time)
+          modl.stop_time = stop_time
+        end
+        return true, modl
+      else
+        return false, response
+      end
+    end
+
+    def create_feature feature
+      path = "/api/create_feature"
+      valid, response = http_post path, feature.to_json
+      
+      if(valid)
+        id = response["_id"]
+        if(id)
+          return true, id
+        end
+      else
+        return false, response
+      end
+    end 
+
+    def create_scenario scenario
+      path = "/api/create_scenario"
+      valid, response = http_post path, scenario.to_json
+      
+      if(valid)
+        id = response["_id"]
+        if(id)
+          return true, id
+        end
+      else
+        return false, response
+      end
+    end 
+
+    def add_step_to_scenario step
+      path = "/api/add_step_to_scenario"
+      valid, response = http_post path, step.to_json
+      
+      if(valid)
+        success = response["success"]
+        if(success)
+          return true, success
+        end
+      else
+        return false, response
+      end
+    end
+
+    def add_embedding_to_scenario embedding
+      path = "/api/add_embedding_to_scenario"
+      valid, response = http_post path, embedding.to_json
+      
+      if(valid)
+        success = response["success"]
+        if(success)
+          return true, success
+        end
+      else
+        return false, response
+      end
+    end
+
+    def http_post path,body
+      begin
+        http = Net::HTTP::Proxy(@proxy.host, @proxy.port).new(@uri.host, @uri.port)
+        request = Net::HTTP::Post.new(path,initheader = { 'Content-Type' => 'application/json'})
+        request.body = body
+        response = http.request(request)
+        case response.code
+          when /20\d/
+            #success
+          else
+            return false,response.body
+        end
+      rescue Exception => ex
+        return false, ex
+      end
+
+      return true, JSON.parse(response.body)
+
+    end
+
+    def http_get path
+      req = Net::HTTP::Get.new(path,)
+      response = Net::HTTP::Proxy(@proxy.host, @proxy.port).new(@uri.host, @uri.port).start {|http| 
+        http.request(req) 
+      }
+      case response.code
+      when /20\d/
+        #success
+      else
+        return false, response.body
+      end
+
+      parsed_response = JSON.parse(response.body)
+      return true,parsed_response
+    end
+
+
+
+
+
+
+      def add_params_to_path (path, params)
+        if(params)
+          path = "#{path}?".concat(params.collect { |k,v| "#{k}=#{CGI::escape(v.to_s)}" }.join('&'))
+        end
+        return path
+      end
+  end
+end
+

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: stdd_api
+version: !ruby/object:Gem::Version
+  version: 0.2.0.1
+platform: ruby
+authors:
+- Anton Danielsson
+- Anders Åslund
+- Learningwell West
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-07 00:00:00.000000000 Z
+dependencies: []
+description: API for reporting to stddtool
+email: anton.danielsson@learningwell.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/stdd_api.rb
+- lib/objects.rb
+homepage: https://github.com/LearningWellWest/ruby-stdd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: API for stddtool
+test_files: []