Core class for api interface operations
Returns all API public methods for a given class.
# File lib/github_api/api/actions.rb, line 6 def self.inherited(klass) klass.class_eval " def self.actions self.new.api_methods_in(#{klass}) end def actions api_methods_in(#{klass}) end ", __FILE__, __LINE__ + 1 super end
Create new API
# File lib/github_api/api.rb, line 41 def initialize(options={}, &block) setup(options) yield_or_eval(&block) if block_given? end
# File lib/github_api/api/actions.rb, line 18 def api_methods_in(klass) puts "---" (klass.send(:instance_methods, false) - ['actions']).sort.each do |method| puts "|--> #{method}" end klass.included_modules.each do |mod| if mod.to_s =~ /#{klass}/ puts "| \\ #{mod.to_s}" mod.instance_methods(false).each do |met| puts "| |--> #{met}" end puts "| /" end end puts "---" nil end
# File lib/github_api/api/actions.rb, line 36 def append_arguments(method) _method = self.method(method) if _method.arity == 0 args = "()" elsif _method.arity > 0 args = "(few)" else args = "(else)" end args end
Acts as setter and getter for api requests arguments parsing.
Returns Arguments instance.
# File lib/github_api/api.rb, line 90 def arguments(args=(not_set = true), options={}, &block) if not_set @arguments else @arguments = Arguments.new(self, options).parse(*args, &block) end end
Extract login and password from basic_auth parameter
# File lib/github_api/api.rb, line 64 def process_basic_auth(auth) case auth when String self.login, self.password = auth.split(':', 2) when Hash self.login = auth[:login] self.password = auth[:password] end end
Set an option to a given value
# File lib/github_api/api.rb, line 113 def set(option, value=(not_set=true), ignore_setter=false, &block) raise ArgumentError, 'value not set' if block and !not_set return self if !not_set and value.nil? if not_set set_options option return self end if respond_to?("#{option}=") and not ignore_setter return __send__("#{option}=", value) end define_accessors option, value self end
Configure options and process basic authorization
# File lib/github_api/api.rb, line 53 def setup(options={}) options = Github.options.merge(options) self.current_options = options Configuration.keys.each do |key| send("#{key}=", options[key]) end process_basic_auth(options[:basic_auth]) end
Scope for passing request required arguments.
# File lib/github_api/api.rb, line 100 def with(args) case args when Hash set args when /.*\/.*/ user, repo = args.split('/') set :user => user, :repo => repo else ::Kernel.raise ArgumentError, 'This api does not support passed in arguments' end end
# File lib/github_api/api.rb, line 46 def yield_or_eval(&block) return unless block block.arity > 0 ? yield(self) : self.instance_eval(&block) end
# File lib/github_api/api.rb, line 141 def define_accessors(option, value) setter = proc { |val| set option, val, true } getter = proc { value } define_singleton_method("#{option}=", setter) if setter define_singleton_method(option, getter) if getter end
Dynamically define a method for setting request option
# File lib/github_api/api.rb, line 151 def define_singleton_method(method_name, content=Proc.new) (class << self; self; end).class_eval do undef_method(method_name) if method_defined?(method_name) if String === content class_eval("def #{method_name}() #{content}; end") else define_method(method_name, &content) end end end
Set multiple options
# File lib/github_api/api.rb, line 134 def set_options(options) unless options.respond_to?(:each) raise ArgumentError, 'cannot iterate over value' end options.each { |key, value| set(key, value) } end