ripe-atlas 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7ec79693b345913501dcd77b03ff69da9540b9c
-  data.tar.gz: dba08726fee18dd90f87fd1ce6481ddc7012ed91
+  metadata.gz: 788cc5c16c6cf59e8a5ce2e018ec1aaef2e4494c
+  data.tar.gz: d0141984d5421a5eca3f96f85e65f9c7a84c0afd
 SHA512:
-  metadata.gz: c4fda0924cb4eb266b09e5698561b9e56e3534270aa2b17d6957f2669712e2001ef83e4c65ec83c1f35d055eab86470bde347bb4caf3edc9014278984d248c4f
-  data.tar.gz: 9935f040db8ba55d8e05b68c0b4e639a7f32f97842c07e63f71668cb1d8d383dd4eb583782f03058c1480b552c8594824f7b97f5f801abeb663172fe12ff02ab
+  metadata.gz: 7e7f685d25bdc72bdab72dd9c29ae3f133527514bac93f6cc1541d9339fdf05d7d5757883ef8aff047779ae86d92d1c279f3f594cec86aa280e2407257bed482
+  data.tar.gz: 03d00156fad9a3726b62fa74320cd8bed422208d9aaa53f119161cd0c870dd4abe2258e1de0e37c4d89074003b7b9980680e93c776b8e75c05c2002279beeedb

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -7,26 +7,15 @@ At the current state of development, you can:
 - Get measurements
 - Stop measurements
 
-## Installation
-Since ripe-atlas is currently not hosted on RubyGems.org, you have to install it manually. 
-
-Clone the GitHub repository. 
-```bash
-git clone https://github.com/EddyShure/ripe-atlas.git
-```
+---
 
-Navigate into the created directory and build the gem.
-```bash
-cd ripe-atlas/
-gem build ripe-atlas.gemspec
-```
-
-Install the gem.
-```bash
-gem install ripe-atlas-*.gem
+## Installation
+```ruby
+gem install ripe-atlas
 ```
+Congratulations, now you can use the ripe-atlas gem!
 
-Congrats, now you can use the ripe-atlas gem!
+---
 
 ## Usage
 
@@ -35,33 +24,34 @@ To use the gem, you should require it first:
 require 'ripe-atlas'
 ```
 
+Then you should create a client. You can pass an API key:
+```ruby
+client = Atlas::Client.new "1234-1234-1234-1234"
+```
+Now, you should be able to do some magic with your freshly initialized client:
+
 ### Getting Atlas probes
 
-To get RIPE Atlas probes, you can use 'Atlas.get_probes'.
+To get RIPE Atlas probes, you can use #get_probes.
 
 ```ruby
-Atlas.get_probes({:id => 333})
+client.get_probes({:id => 333})
 ```
 To get a list of all parameters, visit this site: https://atlas.ripe.net/docs/rest/#probe
 
 ### Getting measurements
 
-To get measurement objects, you can use 'Atlas.get_measurements'.
+To get measurement objects, you can use #get_measurements.
 ```ruby
-Atlas.get_measurements({:status => 3})
+client.get_measurements({:status => 3})
 ```
 List of all parameters: https://atlas.ripe.net/docs/rest/#measurement
 
 ### Stopping measurements
 ```ruby
-Atlas.stop_measurement(id, "api-key")
+client.stop_measurement(id)
 ```
 
-##TODO
-* Add probe-participation-request
-* Clean up code
-* Add MeasurementRequest
-
 ## Donate
 
 If you would like to support me, you can buy me a bottle of Club Mate via GitTip:

data/lib/ripe-atlas.rb

@@ -1,8 +1,12 @@
+require 'json'
+require 'rest_client'
+#require 'time'
+
 module Atlas
 end
 
 require 'ripe-atlas/version'
-require 'ripe-atlas/api'
+require 'ripe-atlas/client'
 require 'ripe-atlas/probe'
 require 'ripe-atlas/measurement'
 

data/lib/ripe-atlas/client.rb

@@ -0,0 +1,73 @@
+module Atlas
+  class Client
+    attr_accessor :key
+    
+    API = "https://atlas.ripe.net/api/v1/"
+
+    def initialize(key = nil)
+      if key.is_a? String and key != nil
+        send("key=", key)
+      end
+    end
+
+    def get_object(type, p)
+      @url = API + "#{type}/"
+      @res = RestClient.get(@url, {:accept => :json, :params => p})
+
+      if @res.code == 200
+        @json = JSON.parse @res.body
+      end
+
+      @objects = Array.new
+      @json["objects"].each do |n|
+        case type
+        when "probe"
+          @objects << Atlas::Probe.new(n)
+        when "measurement" 
+          @objects << Atlas::Measurement.new(n)
+        else
+          raise "F*** you all!"
+        end
+      end
+
+      return @objects
+    end
+
+    def get_probes(p)
+      @probes = get_object("probe", p)
+      return @probes
+    end
+
+    def get_measurements(p)
+      @measurements = get_object("measurement", p)
+      return @measurements
+    end
+
+    def get_measurement(id)
+      @url = API + "measurement/#{id}/"
+      @res = RestClient.get(@url, {:accept => :json})
+
+      if @res.code == 200
+        @json = JSON.parse @res.body
+      end
+
+      @measurement = Atlas::Measurement.new(@json["object"])
+      return @measurement
+    end
+
+    def stop_measurement(id)
+      if self.key == nil
+        raise "Specify an API key!"
+      end
+      @url = API + "measurement/" + "#{id}/" + "?key=" + self.key
+      @res = RestClient.delete(@url)
+      p @res
+      puts @res.code
+      if @res.code == 204
+        return true
+      else
+        return false
+      end
+    end
+  end
+end

data/lib/ripe-atlas/measurement-creation/definitions.rb

@@ -0,0 +1,9 @@
+module Atlas
+  module MeasurementCreation
+    class Definition
+      af = [4, 6]
+      type = [:ping, :traceroute, :dns, :sslcert]
+
+    end
+  end
+end

data/lib/ripe-atlas/{measurement-request.rb → measurement-creation/measurement-request.rb}

@@ -3,6 +3,6 @@ require 'json'
 
 module Atlas
   class MeasurementRequest
-    
+        
   end
 end

data/lib/ripe-atlas/measurement-creation/probes.rb

@@ -0,0 +1,9 @@
+module Atlas
+  module MeasurementCreation
+    class Probes
+
+      def initialize(p)
+      end
+    end
+  end
+end

data/lib/ripe-atlas/measurement.rb

@@ -4,7 +4,6 @@ module Atlas
      :description, :dst_addr, :dst_asn, :dst_name, :interval, :is_oneoff, :is_public, :msm_id, 
      :participant_count, :resolve_on_probe, :resolved_ips, :result, :start_time, :status, :stop_time, :type
    
-   # Just for Eliah Shure: (.)(.)
    def initialize(p)
     p.each do |k,v| 
       send("#{k}=",v)

data/lib/ripe-atlas/probe.rb

@@ -2,8 +2,9 @@ module Atlas
   class Probe
     
     attr_accessor :address_v4, :address_v6, :asn_v4, :asn_v6, :country_code, :id, :is_anchor, 
-      :is_public, :latitude, :longitude, :prefix_v4, :prefix_v6, :status, :status_name, :status_since    
-  
+      :is_public, :latitude, :longitude, :prefix_v4, :prefix_v6, :status, :status_name, :status_since,
+      :tags
+
     def initialize(p)
       p.each do |k,v| 
         send("#{k}=",v)

data/ripe-atlas.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
     
   s.name        = 'ripe-atlas'
-  s.version     = '0.1.1'
-  s.date        = '2014-08-27'
+  s.version     = '0.3.0'
+  s.date        = '2014-09-05'
   s.summary     = "A Ruby gem for the RIPE Atlas API."
   s.description = "ripe-atlas is an API wrapper for the RIPE Atlas API. You can get probes and measurements and even stop measurements."
   s.authors     = ["Eddy Shure"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ripe-atlas
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Eddy Shure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -45,11 +45,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - LICENSE
 - README.md
 - lib/ripe-atlas.rb
-- lib/ripe-atlas/api.rb
-- lib/ripe-atlas/measurement-request.rb
+- lib/ripe-atlas/client.rb
+- lib/ripe-atlas/measurement-creation/definitions.rb
+- lib/ripe-atlas/measurement-creation/measurement-request.rb
+- lib/ripe-atlas/measurement-creation/probes.rb
 - lib/ripe-atlas/measurement.rb
 - lib/ripe-atlas/probe.rb
 - lib/ripe-atlas/version.rb

data/lib/ripe-atlas/api.rb

@@ -1,63 +0,0 @@
-require 'json'
-require 'rest_client'
-
-module Atlas
-  API = "https://atlas.ripe.net/api/v1/"
-  
-  def self.get_object(type, p)
-    @url = API + "#{type}/"
-    @res = RestClient.get(@url, {:accept => :json, :params => p})
-
-    if @res.code == 200
-      @json = JSON.parse @res.body
-    end
-
-    @objects = Array.new
-    @json["objects"].each do |n|
-      case type
-      when "probe"
-        @objects << Atlas::Probe.new(n)
-      when "measurement" 
-        @objects << Atlas::Measurement.new(n)
-      else
-        raise "F*** you all!"
-      end
-    end
-
-    return @objects
-  end
-
-  def self.get_probes(p)
-    @probes = get_object("probe", p)
-    return @probes
-  end
-
-  def self.get_measurements(p)
-    @measurements = get_object("measurement", p)
-    return @measurements
-  end
-
-  def self.get_measurement(id)
-    @url = API + "measurement/#{id}/"
-    @res = RestClient.get(@url, {:accept => :json})
-
-    if @res.code == 200
-      @json = JSON.parse @res.body
-    end
-
-    @measurement = Atlas::Measurement.new(@json["object"])
-    return @measurement
-  end
-
-  def self.stop_measurement(id, key)
-    @url = API + "measurement/" + "#{id}/" + "?key=" + key
-    @res = RestClient.delete(@url)
-    p @res
-    puts @res.code
-    if @res.code == 204
-      return true
-    else
-      return false
-    end
-  end
-end