https://github.com/fooock/shodand
Console and Android native Shodan application. Developed using MVP architecture, RxJava, Butterknife, zxing and more! Looking for collaborators, join now! :metal:
https://github.com/fooock/shodand
android android-application butterknife mvp mvp-android mvp-architecture retrofit2 rxjava-android rxjava2 shodan shodan-api
Last synced: about 1 month ago
JSON representation
Console and Android native Shodan application. Developed using MVP architecture, RxJava, Butterknife, zxing and more! Looking for collaborators, join now! :metal:
- Host: GitHub
- URL: https://github.com/fooock/shodand
- Owner: fooock
- License: other
- Created: 2017-03-27T18:51:36.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-03T21:38:17.000Z (over 7 years ago)
- Last Synced: 2025-02-28T08:05:25.244Z (about 2 months ago)
- Topics: android, android-application, butterknife, mvp, mvp-android, mvp-architecture, retrofit2, rxjava-android, rxjava2, shodan, shodan-api
- Language: Java
- Homepage:
- Size: 275 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ip-search-engines - Shodand
README
# Shodand
Shodand is a console and native Android application developed to consume Shodan data.
It is developed following the principles of MVP architecture. It uses the [jShodan library](https://github.com/fooock/jshodan) (created by me! :smile:) to make the network requests.You can find a complete list of the app dependencies divided by modules in the following file, located at the repository root level:
```bash
buildsystem/libraries.gradle
```
**Important**: Note that this application is under heavy development,
feel free to contribute! :heart:
### Prerequisites
This application works in Android devices ```15+```
### Permissions
This app uses the following **permissions**:
```xml
```
### Uses feature
The application uses the camera, but **is not required**. This is only required if you want to scan your Shodan API key from the QR code provided in your Shodan account. If you don't want to grant this permission you can copy paste your API key.
```xml
```
## Structure
The application is divided in three modules:
* **app**: Contains all views and Android classes. This is the only Android module.
* **domain**: This module contains all business logic. This is a Java module
* **data**: Contains all classes and interfaces to transform and retrieve data from different datasources. This is a Java module.
* **console**: This module contains the Java console application to query Shodan. It uses the domain and data modules.
All modules can be tested separately. Also if you want to create a Java console application, you can reuse the **data** and **domain** modules!
## Views
All views need to implement the [BaseView](https://github.com/fooock/shodand/blob/master/app/src/main/java/com/fooock/app/shodand/view/BaseView.java) interface.
```java
public interface FakeView extends BaseView {
...
}
```
You can use it in ```Fragment``` or ```Activity```
```java
public class FakeFragment implements FakeView {
...
}
```
## Presenters
All presenters must extends the [BasePresenter](https://github.com/fooock/shodand/blob/master/app/src/main/java/com/fooock/app/shodand/presenter/BasePresenter.java) class and pass to it the view type. Imagine you have a view ```FakeView``` that extends the ```BaseView``` interface:
```java
public class FakePresenter extends BasePresenter {
....
}
```
You need to attach the presenter to the view.
```java
public class FakeFragment implements FakeView {
private FakePresenter presenter;
@Override
public View onCreateView(...) {
....
presenter.attachView(this);
...
return view;
}
@Override
public void onDestroy() {
presenter.detachView();
super.onDestroy();
}
}
```
## Interactors
Interactors are use cases. All interactors must extends the ```BaseInteractor``` class. All interactors receive:
* The type of the result
* The interactor params
Imagine you want to create an use case that returns a list of ```String```s and no need params:
```java
public class FakeInteractor extends BaseInteractor, Void> {
@Override
protected Observable> result(Void params) {
return ...
}
}
```
All logic is implemented in the ```result(...)``` method.
## Contributing
Ouuh yeah! Feel free to create issues and send PR's :heart:
## License
```
Copyright 2017 newhouse (nhitbh at gmail dot com)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)
[dill]:
[git-repo-url]:
[john gruber]:
[df1]:
[markdown-it]:
[Ace Editor]:
[node.js]:
[Twitter Bootstrap]:
[jQuery]:
[@tjholowaychuk]:
[express]:
[AngularJS]:
[Gulp]:
[PlDb]:
[PlGh]:
[PlGd]:
[PlOd]:
[PlMe]:
[PlGa]: